Loading...
1/*
2 * Public API and common code for kernel->userspace relay file support.
3 *
4 * See Documentation/filesystems/relay.txt for an overview.
5 *
6 * Copyright (C) 2002-2005 - Tom Zanussi (zanussi@us.ibm.com), IBM Corp
7 * Copyright (C) 1999-2005 - Karim Yaghmour (karim@opersys.com)
8 *
9 * Moved to kernel/relay.c by Paul Mundt, 2006.
10 * November 2006 - CPU hotplug support by Mathieu Desnoyers
11 * (mathieu.desnoyers@polymtl.ca)
12 *
13 * This file is released under the GPL.
14 */
15#include <linux/errno.h>
16#include <linux/stddef.h>
17#include <linux/slab.h>
18#include <linux/export.h>
19#include <linux/string.h>
20#include <linux/relay.h>
21#include <linux/vmalloc.h>
22#include <linux/mm.h>
23#include <linux/cpu.h>
24#include <linux/splice.h>
25
26/* list of open channels, for cpu hotplug */
27static DEFINE_MUTEX(relay_channels_mutex);
28static LIST_HEAD(relay_channels);
29
30/*
31 * close() vm_op implementation for relay file mapping.
32 */
33static void relay_file_mmap_close(struct vm_area_struct *vma)
34{
35 struct rchan_buf *buf = vma->vm_private_data;
36 buf->chan->cb->buf_unmapped(buf, vma->vm_file);
37}
38
39/*
40 * fault() vm_op implementation for relay file mapping.
41 */
42static int relay_buf_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
43{
44 struct page *page;
45 struct rchan_buf *buf = vma->vm_private_data;
46 pgoff_t pgoff = vmf->pgoff;
47
48 if (!buf)
49 return VM_FAULT_OOM;
50
51 page = vmalloc_to_page(buf->start + (pgoff << PAGE_SHIFT));
52 if (!page)
53 return VM_FAULT_SIGBUS;
54 get_page(page);
55 vmf->page = page;
56
57 return 0;
58}
59
60/*
61 * vm_ops for relay file mappings.
62 */
63static const struct vm_operations_struct relay_file_mmap_ops = {
64 .fault = relay_buf_fault,
65 .close = relay_file_mmap_close,
66};
67
68/*
69 * allocate an array of pointers of struct page
70 */
71static struct page **relay_alloc_page_array(unsigned int n_pages)
72{
73 const size_t pa_size = n_pages * sizeof(struct page *);
74 if (pa_size > PAGE_SIZE)
75 return vzalloc(pa_size);
76 return kzalloc(pa_size, GFP_KERNEL);
77}
78
79/*
80 * free an array of pointers of struct page
81 */
82static void relay_free_page_array(struct page **array)
83{
84 kvfree(array);
85}
86
87/**
88 * relay_mmap_buf: - mmap channel buffer to process address space
89 * @buf: relay channel buffer
90 * @vma: vm_area_struct describing memory to be mapped
91 *
92 * Returns 0 if ok, negative on error
93 *
94 * Caller should already have grabbed mmap_sem.
95 */
96static int relay_mmap_buf(struct rchan_buf *buf, struct vm_area_struct *vma)
97{
98 unsigned long length = vma->vm_end - vma->vm_start;
99 struct file *filp = vma->vm_file;
100
101 if (!buf)
102 return -EBADF;
103
104 if (length != (unsigned long)buf->chan->alloc_size)
105 return -EINVAL;
106
107 vma->vm_ops = &relay_file_mmap_ops;
108 vma->vm_flags |= VM_DONTEXPAND;
109 vma->vm_private_data = buf;
110 buf->chan->cb->buf_mapped(buf, filp);
111
112 return 0;
113}
114
115/**
116 * relay_alloc_buf - allocate a channel buffer
117 * @buf: the buffer struct
118 * @size: total size of the buffer
119 *
120 * Returns a pointer to the resulting buffer, %NULL if unsuccessful. The
121 * passed in size will get page aligned, if it isn't already.
122 */
123static void *relay_alloc_buf(struct rchan_buf *buf, size_t *size)
124{
125 void *mem;
126 unsigned int i, j, n_pages;
127
128 *size = PAGE_ALIGN(*size);
129 n_pages = *size >> PAGE_SHIFT;
130
131 buf->page_array = relay_alloc_page_array(n_pages);
132 if (!buf->page_array)
133 return NULL;
134
135 for (i = 0; i < n_pages; i++) {
136 buf->page_array[i] = alloc_page(GFP_KERNEL);
137 if (unlikely(!buf->page_array[i]))
138 goto depopulate;
139 set_page_private(buf->page_array[i], (unsigned long)buf);
140 }
141 mem = vmap(buf->page_array, n_pages, VM_MAP, PAGE_KERNEL);
142 if (!mem)
143 goto depopulate;
144
145 memset(mem, 0, *size);
146 buf->page_count = n_pages;
147 return mem;
148
149depopulate:
150 for (j = 0; j < i; j++)
151 __free_page(buf->page_array[j]);
152 relay_free_page_array(buf->page_array);
153 return NULL;
154}
155
156/**
157 * relay_create_buf - allocate and initialize a channel buffer
158 * @chan: the relay channel
159 *
160 * Returns channel buffer if successful, %NULL otherwise.
161 */
162static struct rchan_buf *relay_create_buf(struct rchan *chan)
163{
164 struct rchan_buf *buf;
165
166 if (chan->n_subbufs > UINT_MAX / sizeof(size_t *))
167 return NULL;
168
169 buf = kzalloc(sizeof(struct rchan_buf), GFP_KERNEL);
170 if (!buf)
171 return NULL;
172 buf->padding = kmalloc(chan->n_subbufs * sizeof(size_t *), GFP_KERNEL);
173 if (!buf->padding)
174 goto free_buf;
175
176 buf->start = relay_alloc_buf(buf, &chan->alloc_size);
177 if (!buf->start)
178 goto free_buf;
179
180 buf->chan = chan;
181 kref_get(&buf->chan->kref);
182 return buf;
183
184free_buf:
185 kfree(buf->padding);
186 kfree(buf);
187 return NULL;
188}
189
190/**
191 * relay_destroy_channel - free the channel struct
192 * @kref: target kernel reference that contains the relay channel
193 *
194 * Should only be called from kref_put().
195 */
196static void relay_destroy_channel(struct kref *kref)
197{
198 struct rchan *chan = container_of(kref, struct rchan, kref);
199 kfree(chan);
200}
201
202/**
203 * relay_destroy_buf - destroy an rchan_buf struct and associated buffer
204 * @buf: the buffer struct
205 */
206static void relay_destroy_buf(struct rchan_buf *buf)
207{
208 struct rchan *chan = buf->chan;
209 unsigned int i;
210
211 if (likely(buf->start)) {
212 vunmap(buf->start);
213 for (i = 0; i < buf->page_count; i++)
214 __free_page(buf->page_array[i]);
215 relay_free_page_array(buf->page_array);
216 }
217 chan->buf[buf->cpu] = NULL;
218 kfree(buf->padding);
219 kfree(buf);
220 kref_put(&chan->kref, relay_destroy_channel);
221}
222
223/**
224 * relay_remove_buf - remove a channel buffer
225 * @kref: target kernel reference that contains the relay buffer
226 *
227 * Removes the file from the filesystem, which also frees the
228 * rchan_buf_struct and the channel buffer. Should only be called from
229 * kref_put().
230 */
231static void relay_remove_buf(struct kref *kref)
232{
233 struct rchan_buf *buf = container_of(kref, struct rchan_buf, kref);
234 relay_destroy_buf(buf);
235}
236
237/**
238 * relay_buf_empty - boolean, is the channel buffer empty?
239 * @buf: channel buffer
240 *
241 * Returns 1 if the buffer is empty, 0 otherwise.
242 */
243static int relay_buf_empty(struct rchan_buf *buf)
244{
245 return (buf->subbufs_produced - buf->subbufs_consumed) ? 0 : 1;
246}
247
248/**
249 * relay_buf_full - boolean, is the channel buffer full?
250 * @buf: channel buffer
251 *
252 * Returns 1 if the buffer is full, 0 otherwise.
253 */
254int relay_buf_full(struct rchan_buf *buf)
255{
256 size_t ready = buf->subbufs_produced - buf->subbufs_consumed;
257 return (ready >= buf->chan->n_subbufs) ? 1 : 0;
258}
259EXPORT_SYMBOL_GPL(relay_buf_full);
260
261/*
262 * High-level relay kernel API and associated functions.
263 */
264
265/*
266 * rchan_callback implementations defining default channel behavior. Used
267 * in place of corresponding NULL values in client callback struct.
268 */
269
270/*
271 * subbuf_start() default callback. Does nothing.
272 */
273static int subbuf_start_default_callback (struct rchan_buf *buf,
274 void *subbuf,
275 void *prev_subbuf,
276 size_t prev_padding)
277{
278 if (relay_buf_full(buf))
279 return 0;
280
281 return 1;
282}
283
284/*
285 * buf_mapped() default callback. Does nothing.
286 */
287static void buf_mapped_default_callback(struct rchan_buf *buf,
288 struct file *filp)
289{
290}
291
292/*
293 * buf_unmapped() default callback. Does nothing.
294 */
295static void buf_unmapped_default_callback(struct rchan_buf *buf,
296 struct file *filp)
297{
298}
299
300/*
301 * create_buf_file_create() default callback. Does nothing.
302 */
303static struct dentry *create_buf_file_default_callback(const char *filename,
304 struct dentry *parent,
305 umode_t mode,
306 struct rchan_buf *buf,
307 int *is_global)
308{
309 return NULL;
310}
311
312/*
313 * remove_buf_file() default callback. Does nothing.
314 */
315static int remove_buf_file_default_callback(struct dentry *dentry)
316{
317 return -EINVAL;
318}
319
320/* relay channel default callbacks */
321static struct rchan_callbacks default_channel_callbacks = {
322 .subbuf_start = subbuf_start_default_callback,
323 .buf_mapped = buf_mapped_default_callback,
324 .buf_unmapped = buf_unmapped_default_callback,
325 .create_buf_file = create_buf_file_default_callback,
326 .remove_buf_file = remove_buf_file_default_callback,
327};
328
329/**
330 * wakeup_readers - wake up readers waiting on a channel
331 * @data: contains the channel buffer
332 *
333 * This is the timer function used to defer reader waking.
334 */
335static void wakeup_readers(unsigned long data)
336{
337 struct rchan_buf *buf = (struct rchan_buf *)data;
338 wake_up_interruptible(&buf->read_wait);
339}
340
341/**
342 * __relay_reset - reset a channel buffer
343 * @buf: the channel buffer
344 * @init: 1 if this is a first-time initialization
345 *
346 * See relay_reset() for description of effect.
347 */
348static void __relay_reset(struct rchan_buf *buf, unsigned int init)
349{
350 size_t i;
351
352 if (init) {
353 init_waitqueue_head(&buf->read_wait);
354 kref_init(&buf->kref);
355 setup_timer(&buf->timer, wakeup_readers, (unsigned long)buf);
356 } else
357 del_timer_sync(&buf->timer);
358
359 buf->subbufs_produced = 0;
360 buf->subbufs_consumed = 0;
361 buf->bytes_consumed = 0;
362 buf->finalized = 0;
363 buf->data = buf->start;
364 buf->offset = 0;
365
366 for (i = 0; i < buf->chan->n_subbufs; i++)
367 buf->padding[i] = 0;
368
369 buf->chan->cb->subbuf_start(buf, buf->data, NULL, 0);
370}
371
372/**
373 * relay_reset - reset the channel
374 * @chan: the channel
375 *
376 * This has the effect of erasing all data from all channel buffers
377 * and restarting the channel in its initial state. The buffers
378 * are not freed, so any mappings are still in effect.
379 *
380 * NOTE. Care should be taken that the channel isn't actually
381 * being used by anything when this call is made.
382 */
383void relay_reset(struct rchan *chan)
384{
385 unsigned int i;
386
387 if (!chan)
388 return;
389
390 if (chan->is_global && chan->buf[0]) {
391 __relay_reset(chan->buf[0], 0);
392 return;
393 }
394
395 mutex_lock(&relay_channels_mutex);
396 for_each_possible_cpu(i)
397 if (chan->buf[i])
398 __relay_reset(chan->buf[i], 0);
399 mutex_unlock(&relay_channels_mutex);
400}
401EXPORT_SYMBOL_GPL(relay_reset);
402
403static inline void relay_set_buf_dentry(struct rchan_buf *buf,
404 struct dentry *dentry)
405{
406 buf->dentry = dentry;
407 d_inode(buf->dentry)->i_size = buf->early_bytes;
408}
409
410static struct dentry *relay_create_buf_file(struct rchan *chan,
411 struct rchan_buf *buf,
412 unsigned int cpu)
413{
414 struct dentry *dentry;
415 char *tmpname;
416
417 tmpname = kzalloc(NAME_MAX + 1, GFP_KERNEL);
418 if (!tmpname)
419 return NULL;
420 snprintf(tmpname, NAME_MAX, "%s%d", chan->base_filename, cpu);
421
422 /* Create file in fs */
423 dentry = chan->cb->create_buf_file(tmpname, chan->parent,
424 S_IRUSR, buf,
425 &chan->is_global);
426
427 kfree(tmpname);
428
429 return dentry;
430}
431
432/*
433 * relay_open_buf - create a new relay channel buffer
434 *
435 * used by relay_open() and CPU hotplug.
436 */
437static struct rchan_buf *relay_open_buf(struct rchan *chan, unsigned int cpu)
438{
439 struct rchan_buf *buf = NULL;
440 struct dentry *dentry;
441
442 if (chan->is_global)
443 return chan->buf[0];
444
445 buf = relay_create_buf(chan);
446 if (!buf)
447 return NULL;
448
449 if (chan->has_base_filename) {
450 dentry = relay_create_buf_file(chan, buf, cpu);
451 if (!dentry)
452 goto free_buf;
453 relay_set_buf_dentry(buf, dentry);
454 }
455
456 buf->cpu = cpu;
457 __relay_reset(buf, 1);
458
459 if(chan->is_global) {
460 chan->buf[0] = buf;
461 buf->cpu = 0;
462 }
463
464 return buf;
465
466free_buf:
467 relay_destroy_buf(buf);
468 return NULL;
469}
470
471/**
472 * relay_close_buf - close a channel buffer
473 * @buf: channel buffer
474 *
475 * Marks the buffer finalized and restores the default callbacks.
476 * The channel buffer and channel buffer data structure are then freed
477 * automatically when the last reference is given up.
478 */
479static void relay_close_buf(struct rchan_buf *buf)
480{
481 buf->finalized = 1;
482 del_timer_sync(&buf->timer);
483 buf->chan->cb->remove_buf_file(buf->dentry);
484 kref_put(&buf->kref, relay_remove_buf);
485}
486
487static void setup_callbacks(struct rchan *chan,
488 struct rchan_callbacks *cb)
489{
490 if (!cb) {
491 chan->cb = &default_channel_callbacks;
492 return;
493 }
494
495 if (!cb->subbuf_start)
496 cb->subbuf_start = subbuf_start_default_callback;
497 if (!cb->buf_mapped)
498 cb->buf_mapped = buf_mapped_default_callback;
499 if (!cb->buf_unmapped)
500 cb->buf_unmapped = buf_unmapped_default_callback;
501 if (!cb->create_buf_file)
502 cb->create_buf_file = create_buf_file_default_callback;
503 if (!cb->remove_buf_file)
504 cb->remove_buf_file = remove_buf_file_default_callback;
505 chan->cb = cb;
506}
507
508/**
509 * relay_hotcpu_callback - CPU hotplug callback
510 * @nb: notifier block
511 * @action: hotplug action to take
512 * @hcpu: CPU number
513 *
514 * Returns the success/failure of the operation. (%NOTIFY_OK, %NOTIFY_BAD)
515 */
516static int relay_hotcpu_callback(struct notifier_block *nb,
517 unsigned long action,
518 void *hcpu)
519{
520 unsigned int hotcpu = (unsigned long)hcpu;
521 struct rchan *chan;
522
523 switch(action) {
524 case CPU_UP_PREPARE:
525 case CPU_UP_PREPARE_FROZEN:
526 mutex_lock(&relay_channels_mutex);
527 list_for_each_entry(chan, &relay_channels, list) {
528 if (chan->buf[hotcpu])
529 continue;
530 chan->buf[hotcpu] = relay_open_buf(chan, hotcpu);
531 if(!chan->buf[hotcpu]) {
532 printk(KERN_ERR
533 "relay_hotcpu_callback: cpu %d buffer "
534 "creation failed\n", hotcpu);
535 mutex_unlock(&relay_channels_mutex);
536 return notifier_from_errno(-ENOMEM);
537 }
538 }
539 mutex_unlock(&relay_channels_mutex);
540 break;
541 case CPU_DEAD:
542 case CPU_DEAD_FROZEN:
543 /* No need to flush the cpu : will be flushed upon
544 * final relay_flush() call. */
545 break;
546 }
547 return NOTIFY_OK;
548}
549
550/**
551 * relay_open - create a new relay channel
552 * @base_filename: base name of files to create, %NULL for buffering only
553 * @parent: dentry of parent directory, %NULL for root directory or buffer
554 * @subbuf_size: size of sub-buffers
555 * @n_subbufs: number of sub-buffers
556 * @cb: client callback functions
557 * @private_data: user-defined data
558 *
559 * Returns channel pointer if successful, %NULL otherwise.
560 *
561 * Creates a channel buffer for each cpu using the sizes and
562 * attributes specified. The created channel buffer files
563 * will be named base_filename0...base_filenameN-1. File
564 * permissions will be %S_IRUSR.
565 */
566struct rchan *relay_open(const char *base_filename,
567 struct dentry *parent,
568 size_t subbuf_size,
569 size_t n_subbufs,
570 struct rchan_callbacks *cb,
571 void *private_data)
572{
573 unsigned int i;
574 struct rchan *chan;
575
576 if (!(subbuf_size && n_subbufs))
577 return NULL;
578 if (subbuf_size > UINT_MAX / n_subbufs)
579 return NULL;
580
581 chan = kzalloc(sizeof(struct rchan), GFP_KERNEL);
582 if (!chan)
583 return NULL;
584
585 chan->version = RELAYFS_CHANNEL_VERSION;
586 chan->n_subbufs = n_subbufs;
587 chan->subbuf_size = subbuf_size;
588 chan->alloc_size = PAGE_ALIGN(subbuf_size * n_subbufs);
589 chan->parent = parent;
590 chan->private_data = private_data;
591 if (base_filename) {
592 chan->has_base_filename = 1;
593 strlcpy(chan->base_filename, base_filename, NAME_MAX);
594 }
595 setup_callbacks(chan, cb);
596 kref_init(&chan->kref);
597
598 mutex_lock(&relay_channels_mutex);
599 for_each_online_cpu(i) {
600 chan->buf[i] = relay_open_buf(chan, i);
601 if (!chan->buf[i])
602 goto free_bufs;
603 }
604 list_add(&chan->list, &relay_channels);
605 mutex_unlock(&relay_channels_mutex);
606
607 return chan;
608
609free_bufs:
610 for_each_possible_cpu(i) {
611 if (chan->buf[i])
612 relay_close_buf(chan->buf[i]);
613 }
614
615 kref_put(&chan->kref, relay_destroy_channel);
616 mutex_unlock(&relay_channels_mutex);
617 return NULL;
618}
619EXPORT_SYMBOL_GPL(relay_open);
620
621struct rchan_percpu_buf_dispatcher {
622 struct rchan_buf *buf;
623 struct dentry *dentry;
624};
625
626/* Called in atomic context. */
627static void __relay_set_buf_dentry(void *info)
628{
629 struct rchan_percpu_buf_dispatcher *p = info;
630
631 relay_set_buf_dentry(p->buf, p->dentry);
632}
633
634/**
635 * relay_late_setup_files - triggers file creation
636 * @chan: channel to operate on
637 * @base_filename: base name of files to create
638 * @parent: dentry of parent directory, %NULL for root directory
639 *
640 * Returns 0 if successful, non-zero otherwise.
641 *
642 * Use to setup files for a previously buffer-only channel.
643 * Useful to do early tracing in kernel, before VFS is up, for example.
644 */
645int relay_late_setup_files(struct rchan *chan,
646 const char *base_filename,
647 struct dentry *parent)
648{
649 int err = 0;
650 unsigned int i, curr_cpu;
651 unsigned long flags;
652 struct dentry *dentry;
653 struct rchan_percpu_buf_dispatcher disp;
654
655 if (!chan || !base_filename)
656 return -EINVAL;
657
658 strlcpy(chan->base_filename, base_filename, NAME_MAX);
659
660 mutex_lock(&relay_channels_mutex);
661 /* Is chan already set up? */
662 if (unlikely(chan->has_base_filename)) {
663 mutex_unlock(&relay_channels_mutex);
664 return -EEXIST;
665 }
666 chan->has_base_filename = 1;
667 chan->parent = parent;
668 curr_cpu = get_cpu();
669 /*
670 * The CPU hotplug notifier ran before us and created buffers with
671 * no files associated. So it's safe to call relay_setup_buf_file()
672 * on all currently online CPUs.
673 */
674 for_each_online_cpu(i) {
675 if (unlikely(!chan->buf[i])) {
676 WARN_ONCE(1, KERN_ERR "CPU has no buffer!\n");
677 err = -EINVAL;
678 break;
679 }
680
681 dentry = relay_create_buf_file(chan, chan->buf[i], i);
682 if (unlikely(!dentry)) {
683 err = -EINVAL;
684 break;
685 }
686
687 if (curr_cpu == i) {
688 local_irq_save(flags);
689 relay_set_buf_dentry(chan->buf[i], dentry);
690 local_irq_restore(flags);
691 } else {
692 disp.buf = chan->buf[i];
693 disp.dentry = dentry;
694 smp_mb();
695 /* relay_channels_mutex must be held, so wait. */
696 err = smp_call_function_single(i,
697 __relay_set_buf_dentry,
698 &disp, 1);
699 }
700 if (unlikely(err))
701 break;
702 }
703 put_cpu();
704 mutex_unlock(&relay_channels_mutex);
705
706 return err;
707}
708
709/**
710 * relay_switch_subbuf - switch to a new sub-buffer
711 * @buf: channel buffer
712 * @length: size of current event
713 *
714 * Returns either the length passed in or 0 if full.
715 *
716 * Performs sub-buffer-switch tasks such as invoking callbacks,
717 * updating padding counts, waking up readers, etc.
718 */
719size_t relay_switch_subbuf(struct rchan_buf *buf, size_t length)
720{
721 void *old, *new;
722 size_t old_subbuf, new_subbuf;
723
724 if (unlikely(length > buf->chan->subbuf_size))
725 goto toobig;
726
727 if (buf->offset != buf->chan->subbuf_size + 1) {
728 buf->prev_padding = buf->chan->subbuf_size - buf->offset;
729 old_subbuf = buf->subbufs_produced % buf->chan->n_subbufs;
730 buf->padding[old_subbuf] = buf->prev_padding;
731 buf->subbufs_produced++;
732 if (buf->dentry)
733 d_inode(buf->dentry)->i_size +=
734 buf->chan->subbuf_size -
735 buf->padding[old_subbuf];
736 else
737 buf->early_bytes += buf->chan->subbuf_size -
738 buf->padding[old_subbuf];
739 smp_mb();
740 if (waitqueue_active(&buf->read_wait))
741 /*
742 * Calling wake_up_interruptible() from here
743 * will deadlock if we happen to be logging
744 * from the scheduler (trying to re-grab
745 * rq->lock), so defer it.
746 */
747 mod_timer(&buf->timer, jiffies + 1);
748 }
749
750 old = buf->data;
751 new_subbuf = buf->subbufs_produced % buf->chan->n_subbufs;
752 new = buf->start + new_subbuf * buf->chan->subbuf_size;
753 buf->offset = 0;
754 if (!buf->chan->cb->subbuf_start(buf, new, old, buf->prev_padding)) {
755 buf->offset = buf->chan->subbuf_size + 1;
756 return 0;
757 }
758 buf->data = new;
759 buf->padding[new_subbuf] = 0;
760
761 if (unlikely(length + buf->offset > buf->chan->subbuf_size))
762 goto toobig;
763
764 return length;
765
766toobig:
767 buf->chan->last_toobig = length;
768 return 0;
769}
770EXPORT_SYMBOL_GPL(relay_switch_subbuf);
771
772/**
773 * relay_subbufs_consumed - update the buffer's sub-buffers-consumed count
774 * @chan: the channel
775 * @cpu: the cpu associated with the channel buffer to update
776 * @subbufs_consumed: number of sub-buffers to add to current buf's count
777 *
778 * Adds to the channel buffer's consumed sub-buffer count.
779 * subbufs_consumed should be the number of sub-buffers newly consumed,
780 * not the total consumed.
781 *
782 * NOTE. Kernel clients don't need to call this function if the channel
783 * mode is 'overwrite'.
784 */
785void relay_subbufs_consumed(struct rchan *chan,
786 unsigned int cpu,
787 size_t subbufs_consumed)
788{
789 struct rchan_buf *buf;
790
791 if (!chan)
792 return;
793
794 if (cpu >= NR_CPUS || !chan->buf[cpu] ||
795 subbufs_consumed > chan->n_subbufs)
796 return;
797
798 buf = chan->buf[cpu];
799 if (subbufs_consumed > buf->subbufs_produced - buf->subbufs_consumed)
800 buf->subbufs_consumed = buf->subbufs_produced;
801 else
802 buf->subbufs_consumed += subbufs_consumed;
803}
804EXPORT_SYMBOL_GPL(relay_subbufs_consumed);
805
806/**
807 * relay_close - close the channel
808 * @chan: the channel
809 *
810 * Closes all channel buffers and frees the channel.
811 */
812void relay_close(struct rchan *chan)
813{
814 unsigned int i;
815
816 if (!chan)
817 return;
818
819 mutex_lock(&relay_channels_mutex);
820 if (chan->is_global && chan->buf[0])
821 relay_close_buf(chan->buf[0]);
822 else
823 for_each_possible_cpu(i)
824 if (chan->buf[i])
825 relay_close_buf(chan->buf[i]);
826
827 if (chan->last_toobig)
828 printk(KERN_WARNING "relay: one or more items not logged "
829 "[item size (%Zd) > sub-buffer size (%Zd)]\n",
830 chan->last_toobig, chan->subbuf_size);
831
832 list_del(&chan->list);
833 kref_put(&chan->kref, relay_destroy_channel);
834 mutex_unlock(&relay_channels_mutex);
835}
836EXPORT_SYMBOL_GPL(relay_close);
837
838/**
839 * relay_flush - close the channel
840 * @chan: the channel
841 *
842 * Flushes all channel buffers, i.e. forces buffer switch.
843 */
844void relay_flush(struct rchan *chan)
845{
846 unsigned int i;
847
848 if (!chan)
849 return;
850
851 if (chan->is_global && chan->buf[0]) {
852 relay_switch_subbuf(chan->buf[0], 0);
853 return;
854 }
855
856 mutex_lock(&relay_channels_mutex);
857 for_each_possible_cpu(i)
858 if (chan->buf[i])
859 relay_switch_subbuf(chan->buf[i], 0);
860 mutex_unlock(&relay_channels_mutex);
861}
862EXPORT_SYMBOL_GPL(relay_flush);
863
864/**
865 * relay_file_open - open file op for relay files
866 * @inode: the inode
867 * @filp: the file
868 *
869 * Increments the channel buffer refcount.
870 */
871static int relay_file_open(struct inode *inode, struct file *filp)
872{
873 struct rchan_buf *buf = inode->i_private;
874 kref_get(&buf->kref);
875 filp->private_data = buf;
876
877 return nonseekable_open(inode, filp);
878}
879
880/**
881 * relay_file_mmap - mmap file op for relay files
882 * @filp: the file
883 * @vma: the vma describing what to map
884 *
885 * Calls upon relay_mmap_buf() to map the file into user space.
886 */
887static int relay_file_mmap(struct file *filp, struct vm_area_struct *vma)
888{
889 struct rchan_buf *buf = filp->private_data;
890 return relay_mmap_buf(buf, vma);
891}
892
893/**
894 * relay_file_poll - poll file op for relay files
895 * @filp: the file
896 * @wait: poll table
897 *
898 * Poll implemention.
899 */
900static unsigned int relay_file_poll(struct file *filp, poll_table *wait)
901{
902 unsigned int mask = 0;
903 struct rchan_buf *buf = filp->private_data;
904
905 if (buf->finalized)
906 return POLLERR;
907
908 if (filp->f_mode & FMODE_READ) {
909 poll_wait(filp, &buf->read_wait, wait);
910 if (!relay_buf_empty(buf))
911 mask |= POLLIN | POLLRDNORM;
912 }
913
914 return mask;
915}
916
917/**
918 * relay_file_release - release file op for relay files
919 * @inode: the inode
920 * @filp: the file
921 *
922 * Decrements the channel refcount, as the filesystem is
923 * no longer using it.
924 */
925static int relay_file_release(struct inode *inode, struct file *filp)
926{
927 struct rchan_buf *buf = filp->private_data;
928 kref_put(&buf->kref, relay_remove_buf);
929
930 return 0;
931}
932
933/*
934 * relay_file_read_consume - update the consumed count for the buffer
935 */
936static void relay_file_read_consume(struct rchan_buf *buf,
937 size_t read_pos,
938 size_t bytes_consumed)
939{
940 size_t subbuf_size = buf->chan->subbuf_size;
941 size_t n_subbufs = buf->chan->n_subbufs;
942 size_t read_subbuf;
943
944 if (buf->subbufs_produced == buf->subbufs_consumed &&
945 buf->offset == buf->bytes_consumed)
946 return;
947
948 if (buf->bytes_consumed + bytes_consumed > subbuf_size) {
949 relay_subbufs_consumed(buf->chan, buf->cpu, 1);
950 buf->bytes_consumed = 0;
951 }
952
953 buf->bytes_consumed += bytes_consumed;
954 if (!read_pos)
955 read_subbuf = buf->subbufs_consumed % n_subbufs;
956 else
957 read_subbuf = read_pos / buf->chan->subbuf_size;
958 if (buf->bytes_consumed + buf->padding[read_subbuf] == subbuf_size) {
959 if ((read_subbuf == buf->subbufs_produced % n_subbufs) &&
960 (buf->offset == subbuf_size))
961 return;
962 relay_subbufs_consumed(buf->chan, buf->cpu, 1);
963 buf->bytes_consumed = 0;
964 }
965}
966
967/*
968 * relay_file_read_avail - boolean, are there unconsumed bytes available?
969 */
970static int relay_file_read_avail(struct rchan_buf *buf, size_t read_pos)
971{
972 size_t subbuf_size = buf->chan->subbuf_size;
973 size_t n_subbufs = buf->chan->n_subbufs;
974 size_t produced = buf->subbufs_produced;
975 size_t consumed = buf->subbufs_consumed;
976
977 relay_file_read_consume(buf, read_pos, 0);
978
979 consumed = buf->subbufs_consumed;
980
981 if (unlikely(buf->offset > subbuf_size)) {
982 if (produced == consumed)
983 return 0;
984 return 1;
985 }
986
987 if (unlikely(produced - consumed >= n_subbufs)) {
988 consumed = produced - n_subbufs + 1;
989 buf->subbufs_consumed = consumed;
990 buf->bytes_consumed = 0;
991 }
992
993 produced = (produced % n_subbufs) * subbuf_size + buf->offset;
994 consumed = (consumed % n_subbufs) * subbuf_size + buf->bytes_consumed;
995
996 if (consumed > produced)
997 produced += n_subbufs * subbuf_size;
998
999 if (consumed == produced) {
1000 if (buf->offset == subbuf_size &&
1001 buf->subbufs_produced > buf->subbufs_consumed)
1002 return 1;
1003 return 0;
1004 }
1005
1006 return 1;
1007}
1008
1009/**
1010 * relay_file_read_subbuf_avail - return bytes available in sub-buffer
1011 * @read_pos: file read position
1012 * @buf: relay channel buffer
1013 */
1014static size_t relay_file_read_subbuf_avail(size_t read_pos,
1015 struct rchan_buf *buf)
1016{
1017 size_t padding, avail = 0;
1018 size_t read_subbuf, read_offset, write_subbuf, write_offset;
1019 size_t subbuf_size = buf->chan->subbuf_size;
1020
1021 write_subbuf = (buf->data - buf->start) / subbuf_size;
1022 write_offset = buf->offset > subbuf_size ? subbuf_size : buf->offset;
1023 read_subbuf = read_pos / subbuf_size;
1024 read_offset = read_pos % subbuf_size;
1025 padding = buf->padding[read_subbuf];
1026
1027 if (read_subbuf == write_subbuf) {
1028 if (read_offset + padding < write_offset)
1029 avail = write_offset - (read_offset + padding);
1030 } else
1031 avail = (subbuf_size - padding) - read_offset;
1032
1033 return avail;
1034}
1035
1036/**
1037 * relay_file_read_start_pos - find the first available byte to read
1038 * @read_pos: file read position
1039 * @buf: relay channel buffer
1040 *
1041 * If the @read_pos is in the middle of padding, return the
1042 * position of the first actually available byte, otherwise
1043 * return the original value.
1044 */
1045static size_t relay_file_read_start_pos(size_t read_pos,
1046 struct rchan_buf *buf)
1047{
1048 size_t read_subbuf, padding, padding_start, padding_end;
1049 size_t subbuf_size = buf->chan->subbuf_size;
1050 size_t n_subbufs = buf->chan->n_subbufs;
1051 size_t consumed = buf->subbufs_consumed % n_subbufs;
1052
1053 if (!read_pos)
1054 read_pos = consumed * subbuf_size + buf->bytes_consumed;
1055 read_subbuf = read_pos / subbuf_size;
1056 padding = buf->padding[read_subbuf];
1057 padding_start = (read_subbuf + 1) * subbuf_size - padding;
1058 padding_end = (read_subbuf + 1) * subbuf_size;
1059 if (read_pos >= padding_start && read_pos < padding_end) {
1060 read_subbuf = (read_subbuf + 1) % n_subbufs;
1061 read_pos = read_subbuf * subbuf_size;
1062 }
1063
1064 return read_pos;
1065}
1066
1067/**
1068 * relay_file_read_end_pos - return the new read position
1069 * @read_pos: file read position
1070 * @buf: relay channel buffer
1071 * @count: number of bytes to be read
1072 */
1073static size_t relay_file_read_end_pos(struct rchan_buf *buf,
1074 size_t read_pos,
1075 size_t count)
1076{
1077 size_t read_subbuf, padding, end_pos;
1078 size_t subbuf_size = buf->chan->subbuf_size;
1079 size_t n_subbufs = buf->chan->n_subbufs;
1080
1081 read_subbuf = read_pos / subbuf_size;
1082 padding = buf->padding[read_subbuf];
1083 if (read_pos % subbuf_size + count + padding == subbuf_size)
1084 end_pos = (read_subbuf + 1) * subbuf_size;
1085 else
1086 end_pos = read_pos + count;
1087 if (end_pos >= subbuf_size * n_subbufs)
1088 end_pos = 0;
1089
1090 return end_pos;
1091}
1092
1093/*
1094 * subbuf_read_actor - read up to one subbuf's worth of data
1095 */
1096static int subbuf_read_actor(size_t read_start,
1097 struct rchan_buf *buf,
1098 size_t avail,
1099 read_descriptor_t *desc)
1100{
1101 void *from;
1102 int ret = 0;
1103
1104 from = buf->start + read_start;
1105 ret = avail;
1106 if (copy_to_user(desc->arg.buf, from, avail)) {
1107 desc->error = -EFAULT;
1108 ret = 0;
1109 }
1110 desc->arg.data += ret;
1111 desc->written += ret;
1112 desc->count -= ret;
1113
1114 return ret;
1115}
1116
1117typedef int (*subbuf_actor_t) (size_t read_start,
1118 struct rchan_buf *buf,
1119 size_t avail,
1120 read_descriptor_t *desc);
1121
1122/*
1123 * relay_file_read_subbufs - read count bytes, bridging subbuf boundaries
1124 */
1125static ssize_t relay_file_read_subbufs(struct file *filp, loff_t *ppos,
1126 subbuf_actor_t subbuf_actor,
1127 read_descriptor_t *desc)
1128{
1129 struct rchan_buf *buf = filp->private_data;
1130 size_t read_start, avail;
1131 int ret;
1132
1133 if (!desc->count)
1134 return 0;
1135
1136 inode_lock(file_inode(filp));
1137 do {
1138 if (!relay_file_read_avail(buf, *ppos))
1139 break;
1140
1141 read_start = relay_file_read_start_pos(*ppos, buf);
1142 avail = relay_file_read_subbuf_avail(read_start, buf);
1143 if (!avail)
1144 break;
1145
1146 avail = min(desc->count, avail);
1147 ret = subbuf_actor(read_start, buf, avail, desc);
1148 if (desc->error < 0)
1149 break;
1150
1151 if (ret) {
1152 relay_file_read_consume(buf, read_start, ret);
1153 *ppos = relay_file_read_end_pos(buf, read_start, ret);
1154 }
1155 } while (desc->count && ret);
1156 inode_unlock(file_inode(filp));
1157
1158 return desc->written;
1159}
1160
1161static ssize_t relay_file_read(struct file *filp,
1162 char __user *buffer,
1163 size_t count,
1164 loff_t *ppos)
1165{
1166 read_descriptor_t desc;
1167 desc.written = 0;
1168 desc.count = count;
1169 desc.arg.buf = buffer;
1170 desc.error = 0;
1171 return relay_file_read_subbufs(filp, ppos, subbuf_read_actor, &desc);
1172}
1173
1174static void relay_consume_bytes(struct rchan_buf *rbuf, int bytes_consumed)
1175{
1176 rbuf->bytes_consumed += bytes_consumed;
1177
1178 if (rbuf->bytes_consumed >= rbuf->chan->subbuf_size) {
1179 relay_subbufs_consumed(rbuf->chan, rbuf->cpu, 1);
1180 rbuf->bytes_consumed %= rbuf->chan->subbuf_size;
1181 }
1182}
1183
1184static void relay_pipe_buf_release(struct pipe_inode_info *pipe,
1185 struct pipe_buffer *buf)
1186{
1187 struct rchan_buf *rbuf;
1188
1189 rbuf = (struct rchan_buf *)page_private(buf->page);
1190 relay_consume_bytes(rbuf, buf->private);
1191}
1192
1193static const struct pipe_buf_operations relay_pipe_buf_ops = {
1194 .can_merge = 0,
1195 .confirm = generic_pipe_buf_confirm,
1196 .release = relay_pipe_buf_release,
1197 .steal = generic_pipe_buf_steal,
1198 .get = generic_pipe_buf_get,
1199};
1200
1201static void relay_page_release(struct splice_pipe_desc *spd, unsigned int i)
1202{
1203}
1204
1205/*
1206 * subbuf_splice_actor - splice up to one subbuf's worth of data
1207 */
1208static ssize_t subbuf_splice_actor(struct file *in,
1209 loff_t *ppos,
1210 struct pipe_inode_info *pipe,
1211 size_t len,
1212 unsigned int flags,
1213 int *nonpad_ret)
1214{
1215 unsigned int pidx, poff, total_len, subbuf_pages, nr_pages;
1216 struct rchan_buf *rbuf = in->private_data;
1217 unsigned int subbuf_size = rbuf->chan->subbuf_size;
1218 uint64_t pos = (uint64_t) *ppos;
1219 uint32_t alloc_size = (uint32_t) rbuf->chan->alloc_size;
1220 size_t read_start = (size_t) do_div(pos, alloc_size);
1221 size_t read_subbuf = read_start / subbuf_size;
1222 size_t padding = rbuf->padding[read_subbuf];
1223 size_t nonpad_end = read_subbuf * subbuf_size + subbuf_size - padding;
1224 struct page *pages[PIPE_DEF_BUFFERS];
1225 struct partial_page partial[PIPE_DEF_BUFFERS];
1226 struct splice_pipe_desc spd = {
1227 .pages = pages,
1228 .nr_pages = 0,
1229 .nr_pages_max = PIPE_DEF_BUFFERS,
1230 .partial = partial,
1231 .flags = flags,
1232 .ops = &relay_pipe_buf_ops,
1233 .spd_release = relay_page_release,
1234 };
1235 ssize_t ret;
1236
1237 if (rbuf->subbufs_produced == rbuf->subbufs_consumed)
1238 return 0;
1239 if (splice_grow_spd(pipe, &spd))
1240 return -ENOMEM;
1241
1242 /*
1243 * Adjust read len, if longer than what is available
1244 */
1245 if (len > (subbuf_size - read_start % subbuf_size))
1246 len = subbuf_size - read_start % subbuf_size;
1247
1248 subbuf_pages = rbuf->chan->alloc_size >> PAGE_SHIFT;
1249 pidx = (read_start / PAGE_SIZE) % subbuf_pages;
1250 poff = read_start & ~PAGE_MASK;
1251 nr_pages = min_t(unsigned int, subbuf_pages, spd.nr_pages_max);
1252
1253 for (total_len = 0; spd.nr_pages < nr_pages; spd.nr_pages++) {
1254 unsigned int this_len, this_end, private;
1255 unsigned int cur_pos = read_start + total_len;
1256
1257 if (!len)
1258 break;
1259
1260 this_len = min_t(unsigned long, len, PAGE_SIZE - poff);
1261 private = this_len;
1262
1263 spd.pages[spd.nr_pages] = rbuf->page_array[pidx];
1264 spd.partial[spd.nr_pages].offset = poff;
1265
1266 this_end = cur_pos + this_len;
1267 if (this_end >= nonpad_end) {
1268 this_len = nonpad_end - cur_pos;
1269 private = this_len + padding;
1270 }
1271 spd.partial[spd.nr_pages].len = this_len;
1272 spd.partial[spd.nr_pages].private = private;
1273
1274 len -= this_len;
1275 total_len += this_len;
1276 poff = 0;
1277 pidx = (pidx + 1) % subbuf_pages;
1278
1279 if (this_end >= nonpad_end) {
1280 spd.nr_pages++;
1281 break;
1282 }
1283 }
1284
1285 ret = 0;
1286 if (!spd.nr_pages)
1287 goto out;
1288
1289 ret = *nonpad_ret = splice_to_pipe(pipe, &spd);
1290 if (ret < 0 || ret < total_len)
1291 goto out;
1292
1293 if (read_start + ret == nonpad_end)
1294 ret += padding;
1295
1296out:
1297 splice_shrink_spd(&spd);
1298 return ret;
1299}
1300
1301static ssize_t relay_file_splice_read(struct file *in,
1302 loff_t *ppos,
1303 struct pipe_inode_info *pipe,
1304 size_t len,
1305 unsigned int flags)
1306{
1307 ssize_t spliced;
1308 int ret;
1309 int nonpad_ret = 0;
1310
1311 ret = 0;
1312 spliced = 0;
1313
1314 while (len && !spliced) {
1315 ret = subbuf_splice_actor(in, ppos, pipe, len, flags, &nonpad_ret);
1316 if (ret < 0)
1317 break;
1318 else if (!ret) {
1319 if (flags & SPLICE_F_NONBLOCK)
1320 ret = -EAGAIN;
1321 break;
1322 }
1323
1324 *ppos += ret;
1325 if (ret > len)
1326 len = 0;
1327 else
1328 len -= ret;
1329 spliced += nonpad_ret;
1330 nonpad_ret = 0;
1331 }
1332
1333 if (spliced)
1334 return spliced;
1335
1336 return ret;
1337}
1338
1339const struct file_operations relay_file_operations = {
1340 .open = relay_file_open,
1341 .poll = relay_file_poll,
1342 .mmap = relay_file_mmap,
1343 .read = relay_file_read,
1344 .llseek = no_llseek,
1345 .release = relay_file_release,
1346 .splice_read = relay_file_splice_read,
1347};
1348EXPORT_SYMBOL_GPL(relay_file_operations);
1349
1350static __init int relay_init(void)
1351{
1352
1353 hotcpu_notifier(relay_hotcpu_callback, 0);
1354 return 0;
1355}
1356
1357early_initcall(relay_init);
1/*
2 * Public API and common code for kernel->userspace relay file support.
3 *
4 * See Documentation/filesystems/relay.rst for an overview.
5 *
6 * Copyright (C) 2002-2005 - Tom Zanussi (zanussi@us.ibm.com), IBM Corp
7 * Copyright (C) 1999-2005 - Karim Yaghmour (karim@opersys.com)
8 *
9 * Moved to kernel/relay.c by Paul Mundt, 2006.
10 * November 2006 - CPU hotplug support by Mathieu Desnoyers
11 * (mathieu.desnoyers@polymtl.ca)
12 *
13 * This file is released under the GPL.
14 */
15#include <linux/errno.h>
16#include <linux/stddef.h>
17#include <linux/slab.h>
18#include <linux/export.h>
19#include <linux/string.h>
20#include <linux/relay.h>
21#include <linux/vmalloc.h>
22#include <linux/mm.h>
23#include <linux/cpu.h>
24#include <linux/splice.h>
25
26/* list of open channels, for cpu hotplug */
27static DEFINE_MUTEX(relay_channels_mutex);
28static LIST_HEAD(relay_channels);
29
30/*
31 * close() vm_op implementation for relay file mapping.
32 */
33static void relay_file_mmap_close(struct vm_area_struct *vma)
34{
35 struct rchan_buf *buf = vma->vm_private_data;
36 buf->chan->cb->buf_unmapped(buf, vma->vm_file);
37}
38
39/*
40 * fault() vm_op implementation for relay file mapping.
41 */
42static vm_fault_t relay_buf_fault(struct vm_fault *vmf)
43{
44 struct page *page;
45 struct rchan_buf *buf = vmf->vma->vm_private_data;
46 pgoff_t pgoff = vmf->pgoff;
47
48 if (!buf)
49 return VM_FAULT_OOM;
50
51 page = vmalloc_to_page(buf->start + (pgoff << PAGE_SHIFT));
52 if (!page)
53 return VM_FAULT_SIGBUS;
54 get_page(page);
55 vmf->page = page;
56
57 return 0;
58}
59
60/*
61 * vm_ops for relay file mappings.
62 */
63static const struct vm_operations_struct relay_file_mmap_ops = {
64 .fault = relay_buf_fault,
65 .close = relay_file_mmap_close,
66};
67
68/*
69 * allocate an array of pointers of struct page
70 */
71static struct page **relay_alloc_page_array(unsigned int n_pages)
72{
73 const size_t pa_size = n_pages * sizeof(struct page *);
74 if (pa_size > PAGE_SIZE)
75 return vzalloc(pa_size);
76 return kzalloc(pa_size, GFP_KERNEL);
77}
78
79/*
80 * free an array of pointers of struct page
81 */
82static void relay_free_page_array(struct page **array)
83{
84 kvfree(array);
85}
86
87/**
88 * relay_mmap_buf: - mmap channel buffer to process address space
89 * @buf: relay channel buffer
90 * @vma: vm_area_struct describing memory to be mapped
91 *
92 * Returns 0 if ok, negative on error
93 *
94 * Caller should already have grabbed mmap_lock.
95 */
96static int relay_mmap_buf(struct rchan_buf *buf, struct vm_area_struct *vma)
97{
98 unsigned long length = vma->vm_end - vma->vm_start;
99 struct file *filp = vma->vm_file;
100
101 if (!buf)
102 return -EBADF;
103
104 if (length != (unsigned long)buf->chan->alloc_size)
105 return -EINVAL;
106
107 vma->vm_ops = &relay_file_mmap_ops;
108 vma->vm_flags |= VM_DONTEXPAND;
109 vma->vm_private_data = buf;
110 buf->chan->cb->buf_mapped(buf, filp);
111
112 return 0;
113}
114
115/**
116 * relay_alloc_buf - allocate a channel buffer
117 * @buf: the buffer struct
118 * @size: total size of the buffer
119 *
120 * Returns a pointer to the resulting buffer, %NULL if unsuccessful. The
121 * passed in size will get page aligned, if it isn't already.
122 */
123static void *relay_alloc_buf(struct rchan_buf *buf, size_t *size)
124{
125 void *mem;
126 unsigned int i, j, n_pages;
127
128 *size = PAGE_ALIGN(*size);
129 n_pages = *size >> PAGE_SHIFT;
130
131 buf->page_array = relay_alloc_page_array(n_pages);
132 if (!buf->page_array)
133 return NULL;
134
135 for (i = 0; i < n_pages; i++) {
136 buf->page_array[i] = alloc_page(GFP_KERNEL);
137 if (unlikely(!buf->page_array[i]))
138 goto depopulate;
139 set_page_private(buf->page_array[i], (unsigned long)buf);
140 }
141 mem = vmap(buf->page_array, n_pages, VM_MAP, PAGE_KERNEL);
142 if (!mem)
143 goto depopulate;
144
145 memset(mem, 0, *size);
146 buf->page_count = n_pages;
147 return mem;
148
149depopulate:
150 for (j = 0; j < i; j++)
151 __free_page(buf->page_array[j]);
152 relay_free_page_array(buf->page_array);
153 return NULL;
154}
155
156/**
157 * relay_create_buf - allocate and initialize a channel buffer
158 * @chan: the relay channel
159 *
160 * Returns channel buffer if successful, %NULL otherwise.
161 */
162static struct rchan_buf *relay_create_buf(struct rchan *chan)
163{
164 struct rchan_buf *buf;
165
166 if (chan->n_subbufs > KMALLOC_MAX_SIZE / sizeof(size_t *))
167 return NULL;
168
169 buf = kzalloc(sizeof(struct rchan_buf), GFP_KERNEL);
170 if (!buf)
171 return NULL;
172 buf->padding = kmalloc_array(chan->n_subbufs, sizeof(size_t *),
173 GFP_KERNEL);
174 if (!buf->padding)
175 goto free_buf;
176
177 buf->start = relay_alloc_buf(buf, &chan->alloc_size);
178 if (!buf->start)
179 goto free_buf;
180
181 buf->chan = chan;
182 kref_get(&buf->chan->kref);
183 return buf;
184
185free_buf:
186 kfree(buf->padding);
187 kfree(buf);
188 return NULL;
189}
190
191/**
192 * relay_destroy_channel - free the channel struct
193 * @kref: target kernel reference that contains the relay channel
194 *
195 * Should only be called from kref_put().
196 */
197static void relay_destroy_channel(struct kref *kref)
198{
199 struct rchan *chan = container_of(kref, struct rchan, kref);
200 free_percpu(chan->buf);
201 kfree(chan);
202}
203
204/**
205 * relay_destroy_buf - destroy an rchan_buf struct and associated buffer
206 * @buf: the buffer struct
207 */
208static void relay_destroy_buf(struct rchan_buf *buf)
209{
210 struct rchan *chan = buf->chan;
211 unsigned int i;
212
213 if (likely(buf->start)) {
214 vunmap(buf->start);
215 for (i = 0; i < buf->page_count; i++)
216 __free_page(buf->page_array[i]);
217 relay_free_page_array(buf->page_array);
218 }
219 *per_cpu_ptr(chan->buf, buf->cpu) = NULL;
220 kfree(buf->padding);
221 kfree(buf);
222 kref_put(&chan->kref, relay_destroy_channel);
223}
224
225/**
226 * relay_remove_buf - remove a channel buffer
227 * @kref: target kernel reference that contains the relay buffer
228 *
229 * Removes the file from the filesystem, which also frees the
230 * rchan_buf_struct and the channel buffer. Should only be called from
231 * kref_put().
232 */
233static void relay_remove_buf(struct kref *kref)
234{
235 struct rchan_buf *buf = container_of(kref, struct rchan_buf, kref);
236 relay_destroy_buf(buf);
237}
238
239/**
240 * relay_buf_empty - boolean, is the channel buffer empty?
241 * @buf: channel buffer
242 *
243 * Returns 1 if the buffer is empty, 0 otherwise.
244 */
245static int relay_buf_empty(struct rchan_buf *buf)
246{
247 return (buf->subbufs_produced - buf->subbufs_consumed) ? 0 : 1;
248}
249
250/**
251 * relay_buf_full - boolean, is the channel buffer full?
252 * @buf: channel buffer
253 *
254 * Returns 1 if the buffer is full, 0 otherwise.
255 */
256int relay_buf_full(struct rchan_buf *buf)
257{
258 size_t ready = buf->subbufs_produced - buf->subbufs_consumed;
259 return (ready >= buf->chan->n_subbufs) ? 1 : 0;
260}
261EXPORT_SYMBOL_GPL(relay_buf_full);
262
263/*
264 * High-level relay kernel API and associated functions.
265 */
266
267/*
268 * rchan_callback implementations defining default channel behavior. Used
269 * in place of corresponding NULL values in client callback struct.
270 */
271
272/*
273 * subbuf_start() default callback. Does nothing.
274 */
275static int subbuf_start_default_callback (struct rchan_buf *buf,
276 void *subbuf,
277 void *prev_subbuf,
278 size_t prev_padding)
279{
280 if (relay_buf_full(buf))
281 return 0;
282
283 return 1;
284}
285
286/*
287 * buf_mapped() default callback. Does nothing.
288 */
289static void buf_mapped_default_callback(struct rchan_buf *buf,
290 struct file *filp)
291{
292}
293
294/*
295 * buf_unmapped() default callback. Does nothing.
296 */
297static void buf_unmapped_default_callback(struct rchan_buf *buf,
298 struct file *filp)
299{
300}
301
302/*
303 * create_buf_file_create() default callback. Does nothing.
304 */
305static struct dentry *create_buf_file_default_callback(const char *filename,
306 struct dentry *parent,
307 umode_t mode,
308 struct rchan_buf *buf,
309 int *is_global)
310{
311 return NULL;
312}
313
314/*
315 * remove_buf_file() default callback. Does nothing.
316 */
317static int remove_buf_file_default_callback(struct dentry *dentry)
318{
319 return -EINVAL;
320}
321
322/* relay channel default callbacks */
323static struct rchan_callbacks default_channel_callbacks = {
324 .subbuf_start = subbuf_start_default_callback,
325 .buf_mapped = buf_mapped_default_callback,
326 .buf_unmapped = buf_unmapped_default_callback,
327 .create_buf_file = create_buf_file_default_callback,
328 .remove_buf_file = remove_buf_file_default_callback,
329};
330
331/**
332 * wakeup_readers - wake up readers waiting on a channel
333 * @work: contains the channel buffer
334 *
335 * This is the function used to defer reader waking
336 */
337static void wakeup_readers(struct irq_work *work)
338{
339 struct rchan_buf *buf;
340
341 buf = container_of(work, struct rchan_buf, wakeup_work);
342 wake_up_interruptible(&buf->read_wait);
343}
344
345/**
346 * __relay_reset - reset a channel buffer
347 * @buf: the channel buffer
348 * @init: 1 if this is a first-time initialization
349 *
350 * See relay_reset() for description of effect.
351 */
352static void __relay_reset(struct rchan_buf *buf, unsigned int init)
353{
354 size_t i;
355
356 if (init) {
357 init_waitqueue_head(&buf->read_wait);
358 kref_init(&buf->kref);
359 init_irq_work(&buf->wakeup_work, wakeup_readers);
360 } else {
361 irq_work_sync(&buf->wakeup_work);
362 }
363
364 buf->subbufs_produced = 0;
365 buf->subbufs_consumed = 0;
366 buf->bytes_consumed = 0;
367 buf->finalized = 0;
368 buf->data = buf->start;
369 buf->offset = 0;
370
371 for (i = 0; i < buf->chan->n_subbufs; i++)
372 buf->padding[i] = 0;
373
374 buf->chan->cb->subbuf_start(buf, buf->data, NULL, 0);
375}
376
377/**
378 * relay_reset - reset the channel
379 * @chan: the channel
380 *
381 * This has the effect of erasing all data from all channel buffers
382 * and restarting the channel in its initial state. The buffers
383 * are not freed, so any mappings are still in effect.
384 *
385 * NOTE. Care should be taken that the channel isn't actually
386 * being used by anything when this call is made.
387 */
388void relay_reset(struct rchan *chan)
389{
390 struct rchan_buf *buf;
391 unsigned int i;
392
393 if (!chan)
394 return;
395
396 if (chan->is_global && (buf = *per_cpu_ptr(chan->buf, 0))) {
397 __relay_reset(buf, 0);
398 return;
399 }
400
401 mutex_lock(&relay_channels_mutex);
402 for_each_possible_cpu(i)
403 if ((buf = *per_cpu_ptr(chan->buf, i)))
404 __relay_reset(buf, 0);
405 mutex_unlock(&relay_channels_mutex);
406}
407EXPORT_SYMBOL_GPL(relay_reset);
408
409static inline void relay_set_buf_dentry(struct rchan_buf *buf,
410 struct dentry *dentry)
411{
412 buf->dentry = dentry;
413 d_inode(buf->dentry)->i_size = buf->early_bytes;
414}
415
416static struct dentry *relay_create_buf_file(struct rchan *chan,
417 struct rchan_buf *buf,
418 unsigned int cpu)
419{
420 struct dentry *dentry;
421 char *tmpname;
422
423 tmpname = kzalloc(NAME_MAX + 1, GFP_KERNEL);
424 if (!tmpname)
425 return NULL;
426 snprintf(tmpname, NAME_MAX, "%s%d", chan->base_filename, cpu);
427
428 /* Create file in fs */
429 dentry = chan->cb->create_buf_file(tmpname, chan->parent,
430 S_IRUSR, buf,
431 &chan->is_global);
432 if (IS_ERR(dentry))
433 dentry = NULL;
434
435 kfree(tmpname);
436
437 return dentry;
438}
439
440/*
441 * relay_open_buf - create a new relay channel buffer
442 *
443 * used by relay_open() and CPU hotplug.
444 */
445static struct rchan_buf *relay_open_buf(struct rchan *chan, unsigned int cpu)
446{
447 struct rchan_buf *buf = NULL;
448 struct dentry *dentry;
449
450 if (chan->is_global)
451 return *per_cpu_ptr(chan->buf, 0);
452
453 buf = relay_create_buf(chan);
454 if (!buf)
455 return NULL;
456
457 if (chan->has_base_filename) {
458 dentry = relay_create_buf_file(chan, buf, cpu);
459 if (!dentry)
460 goto free_buf;
461 relay_set_buf_dentry(buf, dentry);
462 } else {
463 /* Only retrieve global info, nothing more, nothing less */
464 dentry = chan->cb->create_buf_file(NULL, NULL,
465 S_IRUSR, buf,
466 &chan->is_global);
467 if (IS_ERR_OR_NULL(dentry))
468 goto free_buf;
469 }
470
471 buf->cpu = cpu;
472 __relay_reset(buf, 1);
473
474 if(chan->is_global) {
475 *per_cpu_ptr(chan->buf, 0) = buf;
476 buf->cpu = 0;
477 }
478
479 return buf;
480
481free_buf:
482 relay_destroy_buf(buf);
483 return NULL;
484}
485
486/**
487 * relay_close_buf - close a channel buffer
488 * @buf: channel buffer
489 *
490 * Marks the buffer finalized and restores the default callbacks.
491 * The channel buffer and channel buffer data structure are then freed
492 * automatically when the last reference is given up.
493 */
494static void relay_close_buf(struct rchan_buf *buf)
495{
496 buf->finalized = 1;
497 irq_work_sync(&buf->wakeup_work);
498 buf->chan->cb->remove_buf_file(buf->dentry);
499 kref_put(&buf->kref, relay_remove_buf);
500}
501
502static void setup_callbacks(struct rchan *chan,
503 struct rchan_callbacks *cb)
504{
505 if (!cb) {
506 chan->cb = &default_channel_callbacks;
507 return;
508 }
509
510 if (!cb->subbuf_start)
511 cb->subbuf_start = subbuf_start_default_callback;
512 if (!cb->buf_mapped)
513 cb->buf_mapped = buf_mapped_default_callback;
514 if (!cb->buf_unmapped)
515 cb->buf_unmapped = buf_unmapped_default_callback;
516 if (!cb->create_buf_file)
517 cb->create_buf_file = create_buf_file_default_callback;
518 if (!cb->remove_buf_file)
519 cb->remove_buf_file = remove_buf_file_default_callback;
520 chan->cb = cb;
521}
522
523int relay_prepare_cpu(unsigned int cpu)
524{
525 struct rchan *chan;
526 struct rchan_buf *buf;
527
528 mutex_lock(&relay_channels_mutex);
529 list_for_each_entry(chan, &relay_channels, list) {
530 if ((buf = *per_cpu_ptr(chan->buf, cpu)))
531 continue;
532 buf = relay_open_buf(chan, cpu);
533 if (!buf) {
534 pr_err("relay: cpu %d buffer creation failed\n", cpu);
535 mutex_unlock(&relay_channels_mutex);
536 return -ENOMEM;
537 }
538 *per_cpu_ptr(chan->buf, cpu) = buf;
539 }
540 mutex_unlock(&relay_channels_mutex);
541 return 0;
542}
543
544/**
545 * relay_open - create a new relay channel
546 * @base_filename: base name of files to create, %NULL for buffering only
547 * @parent: dentry of parent directory, %NULL for root directory or buffer
548 * @subbuf_size: size of sub-buffers
549 * @n_subbufs: number of sub-buffers
550 * @cb: client callback functions
551 * @private_data: user-defined data
552 *
553 * Returns channel pointer if successful, %NULL otherwise.
554 *
555 * Creates a channel buffer for each cpu using the sizes and
556 * attributes specified. The created channel buffer files
557 * will be named base_filename0...base_filenameN-1. File
558 * permissions will be %S_IRUSR.
559 *
560 * If opening a buffer (@parent = NULL) that you later wish to register
561 * in a filesystem, call relay_late_setup_files() once the @parent dentry
562 * is available.
563 */
564struct rchan *relay_open(const char *base_filename,
565 struct dentry *parent,
566 size_t subbuf_size,
567 size_t n_subbufs,
568 struct rchan_callbacks *cb,
569 void *private_data)
570{
571 unsigned int i;
572 struct rchan *chan;
573 struct rchan_buf *buf;
574
575 if (!(subbuf_size && n_subbufs))
576 return NULL;
577 if (subbuf_size > UINT_MAX / n_subbufs)
578 return NULL;
579
580 chan = kzalloc(sizeof(struct rchan), GFP_KERNEL);
581 if (!chan)
582 return NULL;
583
584 chan->buf = alloc_percpu(struct rchan_buf *);
585 if (!chan->buf) {
586 kfree(chan);
587 return NULL;
588 }
589
590 chan->version = RELAYFS_CHANNEL_VERSION;
591 chan->n_subbufs = n_subbufs;
592 chan->subbuf_size = subbuf_size;
593 chan->alloc_size = PAGE_ALIGN(subbuf_size * n_subbufs);
594 chan->parent = parent;
595 chan->private_data = private_data;
596 if (base_filename) {
597 chan->has_base_filename = 1;
598 strlcpy(chan->base_filename, base_filename, NAME_MAX);
599 }
600 setup_callbacks(chan, cb);
601 kref_init(&chan->kref);
602
603 mutex_lock(&relay_channels_mutex);
604 for_each_online_cpu(i) {
605 buf = relay_open_buf(chan, i);
606 if (!buf)
607 goto free_bufs;
608 *per_cpu_ptr(chan->buf, i) = buf;
609 }
610 list_add(&chan->list, &relay_channels);
611 mutex_unlock(&relay_channels_mutex);
612
613 return chan;
614
615free_bufs:
616 for_each_possible_cpu(i) {
617 if ((buf = *per_cpu_ptr(chan->buf, i)))
618 relay_close_buf(buf);
619 }
620
621 kref_put(&chan->kref, relay_destroy_channel);
622 mutex_unlock(&relay_channels_mutex);
623 return NULL;
624}
625EXPORT_SYMBOL_GPL(relay_open);
626
627struct rchan_percpu_buf_dispatcher {
628 struct rchan_buf *buf;
629 struct dentry *dentry;
630};
631
632/* Called in atomic context. */
633static void __relay_set_buf_dentry(void *info)
634{
635 struct rchan_percpu_buf_dispatcher *p = info;
636
637 relay_set_buf_dentry(p->buf, p->dentry);
638}
639
640/**
641 * relay_late_setup_files - triggers file creation
642 * @chan: channel to operate on
643 * @base_filename: base name of files to create
644 * @parent: dentry of parent directory, %NULL for root directory
645 *
646 * Returns 0 if successful, non-zero otherwise.
647 *
648 * Use to setup files for a previously buffer-only channel created
649 * by relay_open() with a NULL parent dentry.
650 *
651 * For example, this is useful for perfomring early tracing in kernel,
652 * before VFS is up and then exposing the early results once the dentry
653 * is available.
654 */
655int relay_late_setup_files(struct rchan *chan,
656 const char *base_filename,
657 struct dentry *parent)
658{
659 int err = 0;
660 unsigned int i, curr_cpu;
661 unsigned long flags;
662 struct dentry *dentry;
663 struct rchan_buf *buf;
664 struct rchan_percpu_buf_dispatcher disp;
665
666 if (!chan || !base_filename)
667 return -EINVAL;
668
669 strlcpy(chan->base_filename, base_filename, NAME_MAX);
670
671 mutex_lock(&relay_channels_mutex);
672 /* Is chan already set up? */
673 if (unlikely(chan->has_base_filename)) {
674 mutex_unlock(&relay_channels_mutex);
675 return -EEXIST;
676 }
677 chan->has_base_filename = 1;
678 chan->parent = parent;
679
680 if (chan->is_global) {
681 err = -EINVAL;
682 buf = *per_cpu_ptr(chan->buf, 0);
683 if (!WARN_ON_ONCE(!buf)) {
684 dentry = relay_create_buf_file(chan, buf, 0);
685 if (dentry && !WARN_ON_ONCE(!chan->is_global)) {
686 relay_set_buf_dentry(buf, dentry);
687 err = 0;
688 }
689 }
690 mutex_unlock(&relay_channels_mutex);
691 return err;
692 }
693
694 curr_cpu = get_cpu();
695 /*
696 * The CPU hotplug notifier ran before us and created buffers with
697 * no files associated. So it's safe to call relay_setup_buf_file()
698 * on all currently online CPUs.
699 */
700 for_each_online_cpu(i) {
701 buf = *per_cpu_ptr(chan->buf, i);
702 if (unlikely(!buf)) {
703 WARN_ONCE(1, KERN_ERR "CPU has no buffer!\n");
704 err = -EINVAL;
705 break;
706 }
707
708 dentry = relay_create_buf_file(chan, buf, i);
709 if (unlikely(!dentry)) {
710 err = -EINVAL;
711 break;
712 }
713
714 if (curr_cpu == i) {
715 local_irq_save(flags);
716 relay_set_buf_dentry(buf, dentry);
717 local_irq_restore(flags);
718 } else {
719 disp.buf = buf;
720 disp.dentry = dentry;
721 smp_mb();
722 /* relay_channels_mutex must be held, so wait. */
723 err = smp_call_function_single(i,
724 __relay_set_buf_dentry,
725 &disp, 1);
726 }
727 if (unlikely(err))
728 break;
729 }
730 put_cpu();
731 mutex_unlock(&relay_channels_mutex);
732
733 return err;
734}
735EXPORT_SYMBOL_GPL(relay_late_setup_files);
736
737/**
738 * relay_switch_subbuf - switch to a new sub-buffer
739 * @buf: channel buffer
740 * @length: size of current event
741 *
742 * Returns either the length passed in or 0 if full.
743 *
744 * Performs sub-buffer-switch tasks such as invoking callbacks,
745 * updating padding counts, waking up readers, etc.
746 */
747size_t relay_switch_subbuf(struct rchan_buf *buf, size_t length)
748{
749 void *old, *new;
750 size_t old_subbuf, new_subbuf;
751
752 if (unlikely(length > buf->chan->subbuf_size))
753 goto toobig;
754
755 if (buf->offset != buf->chan->subbuf_size + 1) {
756 buf->prev_padding = buf->chan->subbuf_size - buf->offset;
757 old_subbuf = buf->subbufs_produced % buf->chan->n_subbufs;
758 buf->padding[old_subbuf] = buf->prev_padding;
759 buf->subbufs_produced++;
760 if (buf->dentry)
761 d_inode(buf->dentry)->i_size +=
762 buf->chan->subbuf_size -
763 buf->padding[old_subbuf];
764 else
765 buf->early_bytes += buf->chan->subbuf_size -
766 buf->padding[old_subbuf];
767 smp_mb();
768 if (waitqueue_active(&buf->read_wait)) {
769 /*
770 * Calling wake_up_interruptible() from here
771 * will deadlock if we happen to be logging
772 * from the scheduler (trying to re-grab
773 * rq->lock), so defer it.
774 */
775 irq_work_queue(&buf->wakeup_work);
776 }
777 }
778
779 old = buf->data;
780 new_subbuf = buf->subbufs_produced % buf->chan->n_subbufs;
781 new = buf->start + new_subbuf * buf->chan->subbuf_size;
782 buf->offset = 0;
783 if (!buf->chan->cb->subbuf_start(buf, new, old, buf->prev_padding)) {
784 buf->offset = buf->chan->subbuf_size + 1;
785 return 0;
786 }
787 buf->data = new;
788 buf->padding[new_subbuf] = 0;
789
790 if (unlikely(length + buf->offset > buf->chan->subbuf_size))
791 goto toobig;
792
793 return length;
794
795toobig:
796 buf->chan->last_toobig = length;
797 return 0;
798}
799EXPORT_SYMBOL_GPL(relay_switch_subbuf);
800
801/**
802 * relay_subbufs_consumed - update the buffer's sub-buffers-consumed count
803 * @chan: the channel
804 * @cpu: the cpu associated with the channel buffer to update
805 * @subbufs_consumed: number of sub-buffers to add to current buf's count
806 *
807 * Adds to the channel buffer's consumed sub-buffer count.
808 * subbufs_consumed should be the number of sub-buffers newly consumed,
809 * not the total consumed.
810 *
811 * NOTE. Kernel clients don't need to call this function if the channel
812 * mode is 'overwrite'.
813 */
814void relay_subbufs_consumed(struct rchan *chan,
815 unsigned int cpu,
816 size_t subbufs_consumed)
817{
818 struct rchan_buf *buf;
819
820 if (!chan || cpu >= NR_CPUS)
821 return;
822
823 buf = *per_cpu_ptr(chan->buf, cpu);
824 if (!buf || subbufs_consumed > chan->n_subbufs)
825 return;
826
827 if (subbufs_consumed > buf->subbufs_produced - buf->subbufs_consumed)
828 buf->subbufs_consumed = buf->subbufs_produced;
829 else
830 buf->subbufs_consumed += subbufs_consumed;
831}
832EXPORT_SYMBOL_GPL(relay_subbufs_consumed);
833
834/**
835 * relay_close - close the channel
836 * @chan: the channel
837 *
838 * Closes all channel buffers and frees the channel.
839 */
840void relay_close(struct rchan *chan)
841{
842 struct rchan_buf *buf;
843 unsigned int i;
844
845 if (!chan)
846 return;
847
848 mutex_lock(&relay_channels_mutex);
849 if (chan->is_global && (buf = *per_cpu_ptr(chan->buf, 0)))
850 relay_close_buf(buf);
851 else
852 for_each_possible_cpu(i)
853 if ((buf = *per_cpu_ptr(chan->buf, i)))
854 relay_close_buf(buf);
855
856 if (chan->last_toobig)
857 printk(KERN_WARNING "relay: one or more items not logged "
858 "[item size (%zd) > sub-buffer size (%zd)]\n",
859 chan->last_toobig, chan->subbuf_size);
860
861 list_del(&chan->list);
862 kref_put(&chan->kref, relay_destroy_channel);
863 mutex_unlock(&relay_channels_mutex);
864}
865EXPORT_SYMBOL_GPL(relay_close);
866
867/**
868 * relay_flush - close the channel
869 * @chan: the channel
870 *
871 * Flushes all channel buffers, i.e. forces buffer switch.
872 */
873void relay_flush(struct rchan *chan)
874{
875 struct rchan_buf *buf;
876 unsigned int i;
877
878 if (!chan)
879 return;
880
881 if (chan->is_global && (buf = *per_cpu_ptr(chan->buf, 0))) {
882 relay_switch_subbuf(buf, 0);
883 return;
884 }
885
886 mutex_lock(&relay_channels_mutex);
887 for_each_possible_cpu(i)
888 if ((buf = *per_cpu_ptr(chan->buf, i)))
889 relay_switch_subbuf(buf, 0);
890 mutex_unlock(&relay_channels_mutex);
891}
892EXPORT_SYMBOL_GPL(relay_flush);
893
894/**
895 * relay_file_open - open file op for relay files
896 * @inode: the inode
897 * @filp: the file
898 *
899 * Increments the channel buffer refcount.
900 */
901static int relay_file_open(struct inode *inode, struct file *filp)
902{
903 struct rchan_buf *buf = inode->i_private;
904 kref_get(&buf->kref);
905 filp->private_data = buf;
906
907 return nonseekable_open(inode, filp);
908}
909
910/**
911 * relay_file_mmap - mmap file op for relay files
912 * @filp: the file
913 * @vma: the vma describing what to map
914 *
915 * Calls upon relay_mmap_buf() to map the file into user space.
916 */
917static int relay_file_mmap(struct file *filp, struct vm_area_struct *vma)
918{
919 struct rchan_buf *buf = filp->private_data;
920 return relay_mmap_buf(buf, vma);
921}
922
923/**
924 * relay_file_poll - poll file op for relay files
925 * @filp: the file
926 * @wait: poll table
927 *
928 * Poll implemention.
929 */
930static __poll_t relay_file_poll(struct file *filp, poll_table *wait)
931{
932 __poll_t mask = 0;
933 struct rchan_buf *buf = filp->private_data;
934
935 if (buf->finalized)
936 return EPOLLERR;
937
938 if (filp->f_mode & FMODE_READ) {
939 poll_wait(filp, &buf->read_wait, wait);
940 if (!relay_buf_empty(buf))
941 mask |= EPOLLIN | EPOLLRDNORM;
942 }
943
944 return mask;
945}
946
947/**
948 * relay_file_release - release file op for relay files
949 * @inode: the inode
950 * @filp: the file
951 *
952 * Decrements the channel refcount, as the filesystem is
953 * no longer using it.
954 */
955static int relay_file_release(struct inode *inode, struct file *filp)
956{
957 struct rchan_buf *buf = filp->private_data;
958 kref_put(&buf->kref, relay_remove_buf);
959
960 return 0;
961}
962
963/*
964 * relay_file_read_consume - update the consumed count for the buffer
965 */
966static void relay_file_read_consume(struct rchan_buf *buf,
967 size_t read_pos,
968 size_t bytes_consumed)
969{
970 size_t subbuf_size = buf->chan->subbuf_size;
971 size_t n_subbufs = buf->chan->n_subbufs;
972 size_t read_subbuf;
973
974 if (buf->subbufs_produced == buf->subbufs_consumed &&
975 buf->offset == buf->bytes_consumed)
976 return;
977
978 if (buf->bytes_consumed + bytes_consumed > subbuf_size) {
979 relay_subbufs_consumed(buf->chan, buf->cpu, 1);
980 buf->bytes_consumed = 0;
981 }
982
983 buf->bytes_consumed += bytes_consumed;
984 if (!read_pos)
985 read_subbuf = buf->subbufs_consumed % n_subbufs;
986 else
987 read_subbuf = read_pos / buf->chan->subbuf_size;
988 if (buf->bytes_consumed + buf->padding[read_subbuf] == subbuf_size) {
989 if ((read_subbuf == buf->subbufs_produced % n_subbufs) &&
990 (buf->offset == subbuf_size))
991 return;
992 relay_subbufs_consumed(buf->chan, buf->cpu, 1);
993 buf->bytes_consumed = 0;
994 }
995}
996
997/*
998 * relay_file_read_avail - boolean, are there unconsumed bytes available?
999 */
1000static int relay_file_read_avail(struct rchan_buf *buf)
1001{
1002 size_t subbuf_size = buf->chan->subbuf_size;
1003 size_t n_subbufs = buf->chan->n_subbufs;
1004 size_t produced = buf->subbufs_produced;
1005 size_t consumed = buf->subbufs_consumed;
1006
1007 relay_file_read_consume(buf, 0, 0);
1008
1009 consumed = buf->subbufs_consumed;
1010
1011 if (unlikely(buf->offset > subbuf_size)) {
1012 if (produced == consumed)
1013 return 0;
1014 return 1;
1015 }
1016
1017 if (unlikely(produced - consumed >= n_subbufs)) {
1018 consumed = produced - n_subbufs + 1;
1019 buf->subbufs_consumed = consumed;
1020 buf->bytes_consumed = 0;
1021 }
1022
1023 produced = (produced % n_subbufs) * subbuf_size + buf->offset;
1024 consumed = (consumed % n_subbufs) * subbuf_size + buf->bytes_consumed;
1025
1026 if (consumed > produced)
1027 produced += n_subbufs * subbuf_size;
1028
1029 if (consumed == produced) {
1030 if (buf->offset == subbuf_size &&
1031 buf->subbufs_produced > buf->subbufs_consumed)
1032 return 1;
1033 return 0;
1034 }
1035
1036 return 1;
1037}
1038
1039/**
1040 * relay_file_read_subbuf_avail - return bytes available in sub-buffer
1041 * @read_pos: file read position
1042 * @buf: relay channel buffer
1043 */
1044static size_t relay_file_read_subbuf_avail(size_t read_pos,
1045 struct rchan_buf *buf)
1046{
1047 size_t padding, avail = 0;
1048 size_t read_subbuf, read_offset, write_subbuf, write_offset;
1049 size_t subbuf_size = buf->chan->subbuf_size;
1050
1051 write_subbuf = (buf->data - buf->start) / subbuf_size;
1052 write_offset = buf->offset > subbuf_size ? subbuf_size : buf->offset;
1053 read_subbuf = read_pos / subbuf_size;
1054 read_offset = read_pos % subbuf_size;
1055 padding = buf->padding[read_subbuf];
1056
1057 if (read_subbuf == write_subbuf) {
1058 if (read_offset + padding < write_offset)
1059 avail = write_offset - (read_offset + padding);
1060 } else
1061 avail = (subbuf_size - padding) - read_offset;
1062
1063 return avail;
1064}
1065
1066/**
1067 * relay_file_read_start_pos - find the first available byte to read
1068 * @buf: relay channel buffer
1069 *
1070 * If the read_pos is in the middle of padding, return the
1071 * position of the first actually available byte, otherwise
1072 * return the original value.
1073 */
1074static size_t relay_file_read_start_pos(struct rchan_buf *buf)
1075{
1076 size_t read_subbuf, padding, padding_start, padding_end;
1077 size_t subbuf_size = buf->chan->subbuf_size;
1078 size_t n_subbufs = buf->chan->n_subbufs;
1079 size_t consumed = buf->subbufs_consumed % n_subbufs;
1080 size_t read_pos = consumed * subbuf_size + buf->bytes_consumed;
1081
1082 read_subbuf = read_pos / subbuf_size;
1083 padding = buf->padding[read_subbuf];
1084 padding_start = (read_subbuf + 1) * subbuf_size - padding;
1085 padding_end = (read_subbuf + 1) * subbuf_size;
1086 if (read_pos >= padding_start && read_pos < padding_end) {
1087 read_subbuf = (read_subbuf + 1) % n_subbufs;
1088 read_pos = read_subbuf * subbuf_size;
1089 }
1090
1091 return read_pos;
1092}
1093
1094/**
1095 * relay_file_read_end_pos - return the new read position
1096 * @read_pos: file read position
1097 * @buf: relay channel buffer
1098 * @count: number of bytes to be read
1099 */
1100static size_t relay_file_read_end_pos(struct rchan_buf *buf,
1101 size_t read_pos,
1102 size_t count)
1103{
1104 size_t read_subbuf, padding, end_pos;
1105 size_t subbuf_size = buf->chan->subbuf_size;
1106 size_t n_subbufs = buf->chan->n_subbufs;
1107
1108 read_subbuf = read_pos / subbuf_size;
1109 padding = buf->padding[read_subbuf];
1110 if (read_pos % subbuf_size + count + padding == subbuf_size)
1111 end_pos = (read_subbuf + 1) * subbuf_size;
1112 else
1113 end_pos = read_pos + count;
1114 if (end_pos >= subbuf_size * n_subbufs)
1115 end_pos = 0;
1116
1117 return end_pos;
1118}
1119
1120static ssize_t relay_file_read(struct file *filp,
1121 char __user *buffer,
1122 size_t count,
1123 loff_t *ppos)
1124{
1125 struct rchan_buf *buf = filp->private_data;
1126 size_t read_start, avail;
1127 size_t written = 0;
1128 int ret;
1129
1130 if (!count)
1131 return 0;
1132
1133 inode_lock(file_inode(filp));
1134 do {
1135 void *from;
1136
1137 if (!relay_file_read_avail(buf))
1138 break;
1139
1140 read_start = relay_file_read_start_pos(buf);
1141 avail = relay_file_read_subbuf_avail(read_start, buf);
1142 if (!avail)
1143 break;
1144
1145 avail = min(count, avail);
1146 from = buf->start + read_start;
1147 ret = avail;
1148 if (copy_to_user(buffer, from, avail))
1149 break;
1150
1151 buffer += ret;
1152 written += ret;
1153 count -= ret;
1154
1155 relay_file_read_consume(buf, read_start, ret);
1156 *ppos = relay_file_read_end_pos(buf, read_start, ret);
1157 } while (count);
1158 inode_unlock(file_inode(filp));
1159
1160 return written;
1161}
1162
1163static void relay_consume_bytes(struct rchan_buf *rbuf, int bytes_consumed)
1164{
1165 rbuf->bytes_consumed += bytes_consumed;
1166
1167 if (rbuf->bytes_consumed >= rbuf->chan->subbuf_size) {
1168 relay_subbufs_consumed(rbuf->chan, rbuf->cpu, 1);
1169 rbuf->bytes_consumed %= rbuf->chan->subbuf_size;
1170 }
1171}
1172
1173static void relay_pipe_buf_release(struct pipe_inode_info *pipe,
1174 struct pipe_buffer *buf)
1175{
1176 struct rchan_buf *rbuf;
1177
1178 rbuf = (struct rchan_buf *)page_private(buf->page);
1179 relay_consume_bytes(rbuf, buf->private);
1180}
1181
1182static const struct pipe_buf_operations relay_pipe_buf_ops = {
1183 .release = relay_pipe_buf_release,
1184 .try_steal = generic_pipe_buf_try_steal,
1185 .get = generic_pipe_buf_get,
1186};
1187
1188static void relay_page_release(struct splice_pipe_desc *spd, unsigned int i)
1189{
1190}
1191
1192/*
1193 * subbuf_splice_actor - splice up to one subbuf's worth of data
1194 */
1195static ssize_t subbuf_splice_actor(struct file *in,
1196 loff_t *ppos,
1197 struct pipe_inode_info *pipe,
1198 size_t len,
1199 unsigned int flags,
1200 int *nonpad_ret)
1201{
1202 unsigned int pidx, poff, total_len, subbuf_pages, nr_pages;
1203 struct rchan_buf *rbuf = in->private_data;
1204 unsigned int subbuf_size = rbuf->chan->subbuf_size;
1205 uint64_t pos = (uint64_t) *ppos;
1206 uint32_t alloc_size = (uint32_t) rbuf->chan->alloc_size;
1207 size_t read_start = (size_t) do_div(pos, alloc_size);
1208 size_t read_subbuf = read_start / subbuf_size;
1209 size_t padding = rbuf->padding[read_subbuf];
1210 size_t nonpad_end = read_subbuf * subbuf_size + subbuf_size - padding;
1211 struct page *pages[PIPE_DEF_BUFFERS];
1212 struct partial_page partial[PIPE_DEF_BUFFERS];
1213 struct splice_pipe_desc spd = {
1214 .pages = pages,
1215 .nr_pages = 0,
1216 .nr_pages_max = PIPE_DEF_BUFFERS,
1217 .partial = partial,
1218 .ops = &relay_pipe_buf_ops,
1219 .spd_release = relay_page_release,
1220 };
1221 ssize_t ret;
1222
1223 if (rbuf->subbufs_produced == rbuf->subbufs_consumed)
1224 return 0;
1225 if (splice_grow_spd(pipe, &spd))
1226 return -ENOMEM;
1227
1228 /*
1229 * Adjust read len, if longer than what is available
1230 */
1231 if (len > (subbuf_size - read_start % subbuf_size))
1232 len = subbuf_size - read_start % subbuf_size;
1233
1234 subbuf_pages = rbuf->chan->alloc_size >> PAGE_SHIFT;
1235 pidx = (read_start / PAGE_SIZE) % subbuf_pages;
1236 poff = read_start & ~PAGE_MASK;
1237 nr_pages = min_t(unsigned int, subbuf_pages, spd.nr_pages_max);
1238
1239 for (total_len = 0; spd.nr_pages < nr_pages; spd.nr_pages++) {
1240 unsigned int this_len, this_end, private;
1241 unsigned int cur_pos = read_start + total_len;
1242
1243 if (!len)
1244 break;
1245
1246 this_len = min_t(unsigned long, len, PAGE_SIZE - poff);
1247 private = this_len;
1248
1249 spd.pages[spd.nr_pages] = rbuf->page_array[pidx];
1250 spd.partial[spd.nr_pages].offset = poff;
1251
1252 this_end = cur_pos + this_len;
1253 if (this_end >= nonpad_end) {
1254 this_len = nonpad_end - cur_pos;
1255 private = this_len + padding;
1256 }
1257 spd.partial[spd.nr_pages].len = this_len;
1258 spd.partial[spd.nr_pages].private = private;
1259
1260 len -= this_len;
1261 total_len += this_len;
1262 poff = 0;
1263 pidx = (pidx + 1) % subbuf_pages;
1264
1265 if (this_end >= nonpad_end) {
1266 spd.nr_pages++;
1267 break;
1268 }
1269 }
1270
1271 ret = 0;
1272 if (!spd.nr_pages)
1273 goto out;
1274
1275 ret = *nonpad_ret = splice_to_pipe(pipe, &spd);
1276 if (ret < 0 || ret < total_len)
1277 goto out;
1278
1279 if (read_start + ret == nonpad_end)
1280 ret += padding;
1281
1282out:
1283 splice_shrink_spd(&spd);
1284 return ret;
1285}
1286
1287static ssize_t relay_file_splice_read(struct file *in,
1288 loff_t *ppos,
1289 struct pipe_inode_info *pipe,
1290 size_t len,
1291 unsigned int flags)
1292{
1293 ssize_t spliced;
1294 int ret;
1295 int nonpad_ret = 0;
1296
1297 ret = 0;
1298 spliced = 0;
1299
1300 while (len && !spliced) {
1301 ret = subbuf_splice_actor(in, ppos, pipe, len, flags, &nonpad_ret);
1302 if (ret < 0)
1303 break;
1304 else if (!ret) {
1305 if (flags & SPLICE_F_NONBLOCK)
1306 ret = -EAGAIN;
1307 break;
1308 }
1309
1310 *ppos += ret;
1311 if (ret > len)
1312 len = 0;
1313 else
1314 len -= ret;
1315 spliced += nonpad_ret;
1316 nonpad_ret = 0;
1317 }
1318
1319 if (spliced)
1320 return spliced;
1321
1322 return ret;
1323}
1324
1325const struct file_operations relay_file_operations = {
1326 .open = relay_file_open,
1327 .poll = relay_file_poll,
1328 .mmap = relay_file_mmap,
1329 .read = relay_file_read,
1330 .llseek = no_llseek,
1331 .release = relay_file_release,
1332 .splice_read = relay_file_splice_read,
1333};
1334EXPORT_SYMBOL_GPL(relay_file_operations);