2 * Public API and common code for kernel->userspace relay file support.
4 * See Documentation/filesystems/relayfs.txt for an overview of relayfs.
6 * Copyright (C) 2002-2005 - Tom Zanussi (zanussi@us.ibm.com), IBM Corp
7 * Copyright (C) 1999-2005 - Karim Yaghmour (karim@opersys.com)
9 * Moved to kernel/relay.c by Paul Mundt, 2006.
10 * November 2006 - CPU hotplug support by Mathieu Desnoyers
11 * (mathieu.desnoyers@polymtl.ca)
13 * This file is released under the GPL.
15 #include <linux/errno.h>
16 #include <linux/stddef.h>
17 #include <linux/slab.h>
18 #include <linux/module.h>
19 #include <linux/string.h>
20 #include <linux/relay.h>
21 #include <linux/vmalloc.h>
23 #include <linux/cpu.h>
24 #include <linux/splice.h>
26 /* list of open channels, for cpu hotplug */
27 static DEFINE_MUTEX(relay_channels_mutex);
28 static LIST_HEAD(relay_channels);
31 * close() vm_op implementation for relay file mapping.
33 static void relay_file_mmap_close(struct vm_area_struct *vma)
35 struct rchan_buf *buf = vma->vm_private_data;
36 buf->chan->cb->buf_unmapped(buf, vma->vm_file);
40 * nopage() vm_op implementation for relay file mapping.
42 static struct page *relay_buf_nopage(struct vm_area_struct *vma,
43 unsigned long address,
47 struct rchan_buf *buf = vma->vm_private_data;
48 unsigned long offset = address - vma->vm_start;
50 if (address > vma->vm_end)
51 return NOPAGE_SIGBUS; /* Disallow mremap */
55 page = vmalloc_to_page(buf->start + offset);
61 *type = VM_FAULT_MINOR;
67 * vm_ops for relay file mappings.
69 static struct vm_operations_struct relay_file_mmap_ops = {
70 .nopage = relay_buf_nopage,
71 .close = relay_file_mmap_close,
75 * relay_mmap_buf: - mmap channel buffer to process address space
76 * @buf: relay channel buffer
77 * @vma: vm_area_struct describing memory to be mapped
79 * Returns 0 if ok, negative on error
81 * Caller should already have grabbed mmap_sem.
83 static int relay_mmap_buf(struct rchan_buf *buf, struct vm_area_struct *vma)
85 unsigned long length = vma->vm_end - vma->vm_start;
86 struct file *filp = vma->vm_file;
91 if (length != (unsigned long)buf->chan->alloc_size)
94 vma->vm_ops = &relay_file_mmap_ops;
95 vma->vm_private_data = buf;
96 buf->chan->cb->buf_mapped(buf, filp);
102 * relay_alloc_buf - allocate a channel buffer
103 * @buf: the buffer struct
104 * @size: total size of the buffer
106 * Returns a pointer to the resulting buffer, %NULL if unsuccessful. The
107 * passed in size will get page aligned, if it isn't already.
109 static void *relay_alloc_buf(struct rchan_buf *buf, size_t *size)
112 unsigned int i, j, n_pages;
114 *size = PAGE_ALIGN(*size);
115 n_pages = *size >> PAGE_SHIFT;
117 buf->page_array = kcalloc(n_pages, sizeof(struct page *), GFP_KERNEL);
118 if (!buf->page_array)
121 for (i = 0; i < n_pages; i++) {
122 buf->page_array[i] = alloc_page(GFP_KERNEL);
123 if (unlikely(!buf->page_array[i]))
125 set_page_private(buf->page_array[i], (unsigned long)buf);
127 mem = vmap(buf->page_array, n_pages, VM_MAP, PAGE_KERNEL);
131 memset(mem, 0, *size);
132 buf->page_count = n_pages;
136 for (j = 0; j < i; j++)
137 __free_page(buf->page_array[j]);
138 kfree(buf->page_array);
143 * relay_create_buf - allocate and initialize a channel buffer
144 * @chan: the relay channel
146 * Returns channel buffer if successful, %NULL otherwise.
148 static struct rchan_buf *relay_create_buf(struct rchan *chan)
150 struct rchan_buf *buf = kzalloc(sizeof(struct rchan_buf), GFP_KERNEL);
154 buf->padding = kmalloc(chan->n_subbufs * sizeof(size_t *), GFP_KERNEL);
158 buf->start = relay_alloc_buf(buf, &chan->alloc_size);
163 kref_get(&buf->chan->kref);
173 * relay_destroy_channel - free the channel struct
174 * @kref: target kernel reference that contains the relay channel
176 * Should only be called from kref_put().
178 static void relay_destroy_channel(struct kref *kref)
180 struct rchan *chan = container_of(kref, struct rchan, kref);
185 * relay_destroy_buf - destroy an rchan_buf struct and associated buffer
186 * @buf: the buffer struct
188 static void relay_destroy_buf(struct rchan_buf *buf)
190 struct rchan *chan = buf->chan;
193 if (likely(buf->start)) {
195 for (i = 0; i < buf->page_count; i++)
196 __free_page(buf->page_array[i]);
197 kfree(buf->page_array);
199 chan->buf[buf->cpu] = NULL;
202 kref_put(&chan->kref, relay_destroy_channel);
206 * relay_remove_buf - remove a channel buffer
207 * @kref: target kernel reference that contains the relay buffer
209 * Removes the file from the fileystem, which also frees the
210 * rchan_buf_struct and the channel buffer. Should only be called from
213 static void relay_remove_buf(struct kref *kref)
215 struct rchan_buf *buf = container_of(kref, struct rchan_buf, kref);
216 buf->chan->cb->remove_buf_file(buf->dentry);
217 relay_destroy_buf(buf);
221 * relay_buf_empty - boolean, is the channel buffer empty?
222 * @buf: channel buffer
224 * Returns 1 if the buffer is empty, 0 otherwise.
226 static int relay_buf_empty(struct rchan_buf *buf)
228 return (buf->subbufs_produced - buf->subbufs_consumed) ? 0 : 1;
232 * relay_buf_full - boolean, is the channel buffer full?
233 * @buf: channel buffer
235 * Returns 1 if the buffer is full, 0 otherwise.
237 int relay_buf_full(struct rchan_buf *buf)
239 size_t ready = buf->subbufs_produced - buf->subbufs_consumed;
240 return (ready >= buf->chan->n_subbufs) ? 1 : 0;
242 EXPORT_SYMBOL_GPL(relay_buf_full);
245 * High-level relay kernel API and associated functions.
249 * rchan_callback implementations defining default channel behavior. Used
250 * in place of corresponding NULL values in client callback struct.
254 * subbuf_start() default callback. Does nothing.
256 static int subbuf_start_default_callback (struct rchan_buf *buf,
261 if (relay_buf_full(buf))
268 * buf_mapped() default callback. Does nothing.
270 static void buf_mapped_default_callback(struct rchan_buf *buf,
276 * buf_unmapped() default callback. Does nothing.
278 static void buf_unmapped_default_callback(struct rchan_buf *buf,
284 * create_buf_file_create() default callback. Does nothing.
286 static struct dentry *create_buf_file_default_callback(const char *filename,
287 struct dentry *parent,
289 struct rchan_buf *buf,
296 * remove_buf_file() default callback. Does nothing.
298 static int remove_buf_file_default_callback(struct dentry *dentry)
303 /* relay channel default callbacks */
304 static struct rchan_callbacks default_channel_callbacks = {
305 .subbuf_start = subbuf_start_default_callback,
306 .buf_mapped = buf_mapped_default_callback,
307 .buf_unmapped = buf_unmapped_default_callback,
308 .create_buf_file = create_buf_file_default_callback,
309 .remove_buf_file = remove_buf_file_default_callback,
313 * wakeup_readers - wake up readers waiting on a channel
314 * @data: contains the channel buffer
316 * This is the timer function used to defer reader waking.
318 static void wakeup_readers(unsigned long data)
320 struct rchan_buf *buf = (struct rchan_buf *)data;
321 wake_up_interruptible(&buf->read_wait);
325 * __relay_reset - reset a channel buffer
326 * @buf: the channel buffer
327 * @init: 1 if this is a first-time initialization
329 * See relay_reset() for description of effect.
331 static void __relay_reset(struct rchan_buf *buf, unsigned int init)
336 init_waitqueue_head(&buf->read_wait);
337 kref_init(&buf->kref);
338 setup_timer(&buf->timer, wakeup_readers, (unsigned long)buf);
340 del_timer_sync(&buf->timer);
342 buf->subbufs_produced = 0;
343 buf->subbufs_consumed = 0;
344 buf->bytes_consumed = 0;
346 buf->data = buf->start;
349 for (i = 0; i < buf->chan->n_subbufs; i++)
352 buf->chan->cb->subbuf_start(buf, buf->data, NULL, 0);
356 * relay_reset - reset the channel
359 * This has the effect of erasing all data from all channel buffers
360 * and restarting the channel in its initial state. The buffers
361 * are not freed, so any mappings are still in effect.
363 * NOTE. Care should be taken that the channel isn't actually
364 * being used by anything when this call is made.
366 void relay_reset(struct rchan *chan)
373 if (chan->is_global && chan->buf[0]) {
374 __relay_reset(chan->buf[0], 0);
378 mutex_lock(&relay_channels_mutex);
379 for_each_online_cpu(i)
381 __relay_reset(chan->buf[i], 0);
382 mutex_unlock(&relay_channels_mutex);
384 EXPORT_SYMBOL_GPL(relay_reset);
387 * relay_open_buf - create a new relay channel buffer
389 * used by relay_open() and CPU hotplug.
391 static struct rchan_buf *relay_open_buf(struct rchan *chan, unsigned int cpu)
393 struct rchan_buf *buf = NULL;
394 struct dentry *dentry;
400 tmpname = kzalloc(NAME_MAX + 1, GFP_KERNEL);
403 snprintf(tmpname, NAME_MAX, "%s%d", chan->base_filename, cpu);
405 buf = relay_create_buf(chan);
410 __relay_reset(buf, 1);
412 /* Create file in fs */
413 dentry = chan->cb->create_buf_file(tmpname, chan->parent, S_IRUSR,
414 buf, &chan->is_global);
418 buf->dentry = dentry;
420 if(chan->is_global) {
428 relay_destroy_buf(buf);
436 * relay_close_buf - close a channel buffer
437 * @buf: channel buffer
439 * Marks the buffer finalized and restores the default callbacks.
440 * The channel buffer and channel buffer data structure are then freed
441 * automatically when the last reference is given up.
443 static void relay_close_buf(struct rchan_buf *buf)
446 del_timer_sync(&buf->timer);
447 kref_put(&buf->kref, relay_remove_buf);
450 static void setup_callbacks(struct rchan *chan,
451 struct rchan_callbacks *cb)
454 chan->cb = &default_channel_callbacks;
458 if (!cb->subbuf_start)
459 cb->subbuf_start = subbuf_start_default_callback;
461 cb->buf_mapped = buf_mapped_default_callback;
462 if (!cb->buf_unmapped)
463 cb->buf_unmapped = buf_unmapped_default_callback;
464 if (!cb->create_buf_file)
465 cb->create_buf_file = create_buf_file_default_callback;
466 if (!cb->remove_buf_file)
467 cb->remove_buf_file = remove_buf_file_default_callback;
472 * relay_hotcpu_callback - CPU hotplug callback
473 * @nb: notifier block
474 * @action: hotplug action to take
477 * Returns the success/failure of the operation. (%NOTIFY_OK, %NOTIFY_BAD)
479 static int __cpuinit relay_hotcpu_callback(struct notifier_block *nb,
480 unsigned long action,
483 unsigned int hotcpu = (unsigned long)hcpu;
488 case CPU_UP_PREPARE_FROZEN:
489 mutex_lock(&relay_channels_mutex);
490 list_for_each_entry(chan, &relay_channels, list) {
491 if (chan->buf[hotcpu])
493 chan->buf[hotcpu] = relay_open_buf(chan, hotcpu);
494 if(!chan->buf[hotcpu]) {
496 "relay_hotcpu_callback: cpu %d buffer "
497 "creation failed\n", hotcpu);
498 mutex_unlock(&relay_channels_mutex);
502 mutex_unlock(&relay_channels_mutex);
505 case CPU_DEAD_FROZEN:
506 /* No need to flush the cpu : will be flushed upon
507 * final relay_flush() call. */
514 * relay_open - create a new relay channel
515 * @base_filename: base name of files to create
516 * @parent: dentry of parent directory, %NULL for root directory
517 * @subbuf_size: size of sub-buffers
518 * @n_subbufs: number of sub-buffers
519 * @cb: client callback functions
520 * @private_data: user-defined data
522 * Returns channel pointer if successful, %NULL otherwise.
524 * Creates a channel buffer for each cpu using the sizes and
525 * attributes specified. The created channel buffer files
526 * will be named base_filename0...base_filenameN-1. File
527 * permissions will be %S_IRUSR.
529 struct rchan *relay_open(const char *base_filename,
530 struct dentry *parent,
533 struct rchan_callbacks *cb,
541 if (!(subbuf_size && n_subbufs))
544 chan = kzalloc(sizeof(struct rchan), GFP_KERNEL);
548 chan->version = RELAYFS_CHANNEL_VERSION;
549 chan->n_subbufs = n_subbufs;
550 chan->subbuf_size = subbuf_size;
551 chan->alloc_size = FIX_SIZE(subbuf_size * n_subbufs);
552 chan->parent = parent;
553 chan->private_data = private_data;
554 strlcpy(chan->base_filename, base_filename, NAME_MAX);
555 setup_callbacks(chan, cb);
556 kref_init(&chan->kref);
558 mutex_lock(&relay_channels_mutex);
559 for_each_online_cpu(i) {
560 chan->buf[i] = relay_open_buf(chan, i);
564 list_add(&chan->list, &relay_channels);
565 mutex_unlock(&relay_channels_mutex);
570 for_each_online_cpu(i) {
573 relay_close_buf(chan->buf[i]);
576 kref_put(&chan->kref, relay_destroy_channel);
577 mutex_unlock(&relay_channels_mutex);
580 EXPORT_SYMBOL_GPL(relay_open);
583 * relay_switch_subbuf - switch to a new sub-buffer
584 * @buf: channel buffer
585 * @length: size of current event
587 * Returns either the length passed in or 0 if full.
589 * Performs sub-buffer-switch tasks such as invoking callbacks,
590 * updating padding counts, waking up readers, etc.
592 size_t relay_switch_subbuf(struct rchan_buf *buf, size_t length)
595 size_t old_subbuf, new_subbuf;
597 if (unlikely(length > buf->chan->subbuf_size))
600 if (buf->offset != buf->chan->subbuf_size + 1) {
601 buf->prev_padding = buf->chan->subbuf_size - buf->offset;
602 old_subbuf = buf->subbufs_produced % buf->chan->n_subbufs;
603 buf->padding[old_subbuf] = buf->prev_padding;
604 buf->subbufs_produced++;
605 buf->dentry->d_inode->i_size += buf->chan->subbuf_size -
606 buf->padding[old_subbuf];
608 if (waitqueue_active(&buf->read_wait))
610 * Calling wake_up_interruptible() from here
611 * will deadlock if we happen to be logging
612 * from the scheduler (trying to re-grab
613 * rq->lock), so defer it.
615 __mod_timer(&buf->timer, jiffies + 1);
619 new_subbuf = buf->subbufs_produced % buf->chan->n_subbufs;
620 new = buf->start + new_subbuf * buf->chan->subbuf_size;
622 if (!buf->chan->cb->subbuf_start(buf, new, old, buf->prev_padding)) {
623 buf->offset = buf->chan->subbuf_size + 1;
627 buf->padding[new_subbuf] = 0;
629 if (unlikely(length + buf->offset > buf->chan->subbuf_size))
635 buf->chan->last_toobig = length;
638 EXPORT_SYMBOL_GPL(relay_switch_subbuf);
641 * relay_subbufs_consumed - update the buffer's sub-buffers-consumed count
643 * @cpu: the cpu associated with the channel buffer to update
644 * @subbufs_consumed: number of sub-buffers to add to current buf's count
646 * Adds to the channel buffer's consumed sub-buffer count.
647 * subbufs_consumed should be the number of sub-buffers newly consumed,
648 * not the total consumed.
650 * NOTE. Kernel clients don't need to call this function if the channel
651 * mode is 'overwrite'.
653 void relay_subbufs_consumed(struct rchan *chan,
655 size_t subbufs_consumed)
657 struct rchan_buf *buf;
662 if (cpu >= NR_CPUS || !chan->buf[cpu])
665 buf = chan->buf[cpu];
666 buf->subbufs_consumed += subbufs_consumed;
667 if (buf->subbufs_consumed > buf->subbufs_produced)
668 buf->subbufs_consumed = buf->subbufs_produced;
670 EXPORT_SYMBOL_GPL(relay_subbufs_consumed);
673 * relay_close - close the channel
676 * Closes all channel buffers and frees the channel.
678 void relay_close(struct rchan *chan)
685 mutex_lock(&relay_channels_mutex);
686 if (chan->is_global && chan->buf[0])
687 relay_close_buf(chan->buf[0]);
689 for_each_possible_cpu(i)
691 relay_close_buf(chan->buf[i]);
693 if (chan->last_toobig)
694 printk(KERN_WARNING "relay: one or more items not logged "
695 "[item size (%Zd) > sub-buffer size (%Zd)]\n",
696 chan->last_toobig, chan->subbuf_size);
698 list_del(&chan->list);
699 kref_put(&chan->kref, relay_destroy_channel);
700 mutex_unlock(&relay_channels_mutex);
702 EXPORT_SYMBOL_GPL(relay_close);
705 * relay_flush - close the channel
708 * Flushes all channel buffers, i.e. forces buffer switch.
710 void relay_flush(struct rchan *chan)
717 if (chan->is_global && chan->buf[0]) {
718 relay_switch_subbuf(chan->buf[0], 0);
722 mutex_lock(&relay_channels_mutex);
723 for_each_possible_cpu(i)
725 relay_switch_subbuf(chan->buf[i], 0);
726 mutex_unlock(&relay_channels_mutex);
728 EXPORT_SYMBOL_GPL(relay_flush);
731 * relay_file_open - open file op for relay files
735 * Increments the channel buffer refcount.
737 static int relay_file_open(struct inode *inode, struct file *filp)
739 struct rchan_buf *buf = inode->i_private;
740 kref_get(&buf->kref);
741 filp->private_data = buf;
747 * relay_file_mmap - mmap file op for relay files
749 * @vma: the vma describing what to map
751 * Calls upon relay_mmap_buf() to map the file into user space.
753 static int relay_file_mmap(struct file *filp, struct vm_area_struct *vma)
755 struct rchan_buf *buf = filp->private_data;
756 return relay_mmap_buf(buf, vma);
760 * relay_file_poll - poll file op for relay files
766 static unsigned int relay_file_poll(struct file *filp, poll_table *wait)
768 unsigned int mask = 0;
769 struct rchan_buf *buf = filp->private_data;
774 if (filp->f_mode & FMODE_READ) {
775 poll_wait(filp, &buf->read_wait, wait);
776 if (!relay_buf_empty(buf))
777 mask |= POLLIN | POLLRDNORM;
784 * relay_file_release - release file op for relay files
788 * Decrements the channel refcount, as the filesystem is
789 * no longer using it.
791 static int relay_file_release(struct inode *inode, struct file *filp)
793 struct rchan_buf *buf = filp->private_data;
794 kref_put(&buf->kref, relay_remove_buf);
800 * relay_file_read_consume - update the consumed count for the buffer
802 static void relay_file_read_consume(struct rchan_buf *buf,
804 size_t bytes_consumed)
806 size_t subbuf_size = buf->chan->subbuf_size;
807 size_t n_subbufs = buf->chan->n_subbufs;
810 if (buf->bytes_consumed + bytes_consumed > subbuf_size) {
811 relay_subbufs_consumed(buf->chan, buf->cpu, 1);
812 buf->bytes_consumed = 0;
815 buf->bytes_consumed += bytes_consumed;
817 read_subbuf = buf->subbufs_consumed % n_subbufs;
819 read_subbuf = read_pos / buf->chan->subbuf_size;
820 if (buf->bytes_consumed + buf->padding[read_subbuf] == subbuf_size) {
821 if ((read_subbuf == buf->subbufs_produced % n_subbufs) &&
822 (buf->offset == subbuf_size))
824 relay_subbufs_consumed(buf->chan, buf->cpu, 1);
825 buf->bytes_consumed = 0;
830 * relay_file_read_avail - boolean, are there unconsumed bytes available?
832 static int relay_file_read_avail(struct rchan_buf *buf, size_t read_pos)
834 size_t subbuf_size = buf->chan->subbuf_size;
835 size_t n_subbufs = buf->chan->n_subbufs;
836 size_t produced = buf->subbufs_produced;
837 size_t consumed = buf->subbufs_consumed;
839 relay_file_read_consume(buf, read_pos, 0);
841 if (unlikely(buf->offset > subbuf_size)) {
842 if (produced == consumed)
847 if (unlikely(produced - consumed >= n_subbufs)) {
848 consumed = produced - n_subbufs + 1;
849 buf->subbufs_consumed = consumed;
850 buf->bytes_consumed = 0;
853 produced = (produced % n_subbufs) * subbuf_size + buf->offset;
854 consumed = (consumed % n_subbufs) * subbuf_size + buf->bytes_consumed;
856 if (consumed > produced)
857 produced += n_subbufs * subbuf_size;
859 if (consumed == produced)
866 * relay_file_read_subbuf_avail - return bytes available in sub-buffer
867 * @read_pos: file read position
868 * @buf: relay channel buffer
870 static size_t relay_file_read_subbuf_avail(size_t read_pos,
871 struct rchan_buf *buf)
873 size_t padding, avail = 0;
874 size_t read_subbuf, read_offset, write_subbuf, write_offset;
875 size_t subbuf_size = buf->chan->subbuf_size;
877 write_subbuf = (buf->data - buf->start) / subbuf_size;
878 write_offset = buf->offset > subbuf_size ? subbuf_size : buf->offset;
879 read_subbuf = read_pos / subbuf_size;
880 read_offset = read_pos % subbuf_size;
881 padding = buf->padding[read_subbuf];
883 if (read_subbuf == write_subbuf) {
884 if (read_offset + padding < write_offset)
885 avail = write_offset - (read_offset + padding);
887 avail = (subbuf_size - padding) - read_offset;
893 * relay_file_read_start_pos - find the first available byte to read
894 * @read_pos: file read position
895 * @buf: relay channel buffer
897 * If the @read_pos is in the middle of padding, return the
898 * position of the first actually available byte, otherwise
899 * return the original value.
901 static size_t relay_file_read_start_pos(size_t read_pos,
902 struct rchan_buf *buf)
904 size_t read_subbuf, padding, padding_start, padding_end;
905 size_t subbuf_size = buf->chan->subbuf_size;
906 size_t n_subbufs = buf->chan->n_subbufs;
907 size_t consumed = buf->subbufs_consumed % n_subbufs;
910 read_pos = consumed * subbuf_size + buf->bytes_consumed;
911 read_subbuf = read_pos / subbuf_size;
912 padding = buf->padding[read_subbuf];
913 padding_start = (read_subbuf + 1) * subbuf_size - padding;
914 padding_end = (read_subbuf + 1) * subbuf_size;
915 if (read_pos >= padding_start && read_pos < padding_end) {
916 read_subbuf = (read_subbuf + 1) % n_subbufs;
917 read_pos = read_subbuf * subbuf_size;
924 * relay_file_read_end_pos - return the new read position
925 * @read_pos: file read position
926 * @buf: relay channel buffer
927 * @count: number of bytes to be read
929 static size_t relay_file_read_end_pos(struct rchan_buf *buf,
933 size_t read_subbuf, padding, end_pos;
934 size_t subbuf_size = buf->chan->subbuf_size;
935 size_t n_subbufs = buf->chan->n_subbufs;
937 read_subbuf = read_pos / subbuf_size;
938 padding = buf->padding[read_subbuf];
939 if (read_pos % subbuf_size + count + padding == subbuf_size)
940 end_pos = (read_subbuf + 1) * subbuf_size;
942 end_pos = read_pos + count;
943 if (end_pos >= subbuf_size * n_subbufs)
950 * subbuf_read_actor - read up to one subbuf's worth of data
952 static int subbuf_read_actor(size_t read_start,
953 struct rchan_buf *buf,
955 read_descriptor_t *desc,
961 from = buf->start + read_start;
963 if (copy_to_user(desc->arg.buf, from, avail)) {
964 desc->error = -EFAULT;
967 desc->arg.data += ret;
968 desc->written += ret;
974 typedef int (*subbuf_actor_t) (size_t read_start,
975 struct rchan_buf *buf,
977 read_descriptor_t *desc,
981 * relay_file_read_subbufs - read count bytes, bridging subbuf boundaries
983 static ssize_t relay_file_read_subbufs(struct file *filp, loff_t *ppos,
984 subbuf_actor_t subbuf_actor,
986 read_descriptor_t *desc)
988 struct rchan_buf *buf = filp->private_data;
989 size_t read_start, avail;
995 mutex_lock(&filp->f_path.dentry->d_inode->i_mutex);
997 if (!relay_file_read_avail(buf, *ppos))
1000 read_start = relay_file_read_start_pos(*ppos, buf);
1001 avail = relay_file_read_subbuf_avail(read_start, buf);
1005 avail = min(desc->count, avail);
1006 ret = subbuf_actor(read_start, buf, avail, desc, actor);
1007 if (desc->error < 0)
1011 relay_file_read_consume(buf, read_start, ret);
1012 *ppos = relay_file_read_end_pos(buf, read_start, ret);
1014 } while (desc->count && ret);
1015 mutex_unlock(&filp->f_path.dentry->d_inode->i_mutex);
1017 return desc->written;
1020 static ssize_t relay_file_read(struct file *filp,
1021 char __user *buffer,
1025 read_descriptor_t desc;
1028 desc.arg.buf = buffer;
1030 return relay_file_read_subbufs(filp, ppos, subbuf_read_actor,
1034 static void relay_consume_bytes(struct rchan_buf *rbuf, int bytes_consumed)
1036 rbuf->bytes_consumed += bytes_consumed;
1038 if (rbuf->bytes_consumed >= rbuf->chan->subbuf_size) {
1039 relay_subbufs_consumed(rbuf->chan, rbuf->cpu, 1);
1040 rbuf->bytes_consumed %= rbuf->chan->subbuf_size;
1044 static void relay_pipe_buf_release(struct pipe_inode_info *pipe,
1045 struct pipe_buffer *buf)
1047 struct rchan_buf *rbuf;
1049 rbuf = (struct rchan_buf *)page_private(buf->page);
1050 relay_consume_bytes(rbuf, buf->private);
1053 static struct pipe_buf_operations relay_pipe_buf_ops = {
1055 .map = generic_pipe_buf_map,
1056 .unmap = generic_pipe_buf_unmap,
1057 .confirm = generic_pipe_buf_confirm,
1058 .release = relay_pipe_buf_release,
1059 .steal = generic_pipe_buf_steal,
1060 .get = generic_pipe_buf_get,
1064 * subbuf_splice_actor - splice up to one subbuf's worth of data
1066 static int subbuf_splice_actor(struct file *in,
1068 struct pipe_inode_info *pipe,
1073 unsigned int pidx, poff, total_len, subbuf_pages, ret;
1074 struct rchan_buf *rbuf = in->private_data;
1075 unsigned int subbuf_size = rbuf->chan->subbuf_size;
1076 uint64_t pos = (uint64_t) *ppos;
1077 uint32_t alloc_size = (uint32_t) rbuf->chan->alloc_size;
1078 size_t read_start = (size_t) do_div(pos, alloc_size);
1079 size_t read_subbuf = read_start / subbuf_size;
1080 size_t padding = rbuf->padding[read_subbuf];
1081 size_t nonpad_end = read_subbuf * subbuf_size + subbuf_size - padding;
1082 struct page *pages[PIPE_BUFFERS];
1083 struct partial_page partial[PIPE_BUFFERS];
1084 struct splice_pipe_desc spd = {
1089 .ops = &relay_pipe_buf_ops,
1092 if (rbuf->subbufs_produced == rbuf->subbufs_consumed)
1096 * Adjust read len, if longer than what is available
1098 if (len > (subbuf_size - read_start % subbuf_size))
1099 len = subbuf_size - read_start % subbuf_size;
1101 subbuf_pages = rbuf->chan->alloc_size >> PAGE_SHIFT;
1102 pidx = (read_start / PAGE_SIZE) % subbuf_pages;
1103 poff = read_start & ~PAGE_MASK;
1105 for (total_len = 0; spd.nr_pages < subbuf_pages; spd.nr_pages++) {
1106 unsigned int this_len, this_end, private;
1107 unsigned int cur_pos = read_start + total_len;
1112 this_len = min_t(unsigned long, len, PAGE_SIZE - poff);
1115 spd.pages[spd.nr_pages] = rbuf->page_array[pidx];
1116 spd.partial[spd.nr_pages].offset = poff;
1118 this_end = cur_pos + this_len;
1119 if (this_end >= nonpad_end) {
1120 this_len = nonpad_end - cur_pos;
1121 private = this_len + padding;
1123 spd.partial[spd.nr_pages].len = this_len;
1124 spd.partial[spd.nr_pages].private = private;
1127 total_len += this_len;
1129 pidx = (pidx + 1) % subbuf_pages;
1131 if (this_end >= nonpad_end) {
1140 ret = *nonpad_ret = splice_to_pipe(pipe, &spd);
1141 if (ret < 0 || ret < total_len)
1144 if (read_start + ret == nonpad_end)
1150 static ssize_t relay_file_splice_read(struct file *in,
1152 struct pipe_inode_info *pipe,
1164 ret = subbuf_splice_actor(in, ppos, pipe, len, flags, &nonpad_ret);
1170 if (flags & SPLICE_F_NONBLOCK) {
1181 spliced += nonpad_ret;
1191 const struct file_operations relay_file_operations = {
1192 .open = relay_file_open,
1193 .poll = relay_file_poll,
1194 .mmap = relay_file_mmap,
1195 .read = relay_file_read,
1196 .llseek = no_llseek,
1197 .release = relay_file_release,
1198 .splice_read = relay_file_splice_read,
1200 EXPORT_SYMBOL_GPL(relay_file_operations);
1202 static __init int relay_init(void)
1205 hotcpu_notifier(relay_hotcpu_callback, 0);
1209 module_init(relay_init);