From patchwork Wed Mar 22 10:22:43 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Vincent Donnefort X-Patchwork-Id: 13183833 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 4D637C7619A for ; Wed, 22 Mar 2023 10:27:03 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230215AbjCVK1C (ORCPT ); Wed, 22 Mar 2023 06:27:02 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34596 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230160AbjCVK1A (ORCPT ); Wed, 22 Mar 2023 06:27:00 -0400 Received: from mail-wr1-x44a.google.com (mail-wr1-x44a.google.com [IPv6:2a00:1450:4864:20::44a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id EF95C5DCAA for ; Wed, 22 Mar 2023 03:26:51 -0700 (PDT) Received: by mail-wr1-x44a.google.com with SMTP id p1-20020a5d6381000000b002cea6b2d5a9so2082667wru.14 for ; Wed, 22 Mar 2023 03:26:51 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; t=1679480810; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=rV+vYVknDk0KS9H5P2B179jKwjCKWF8rdd5yxyHRKuo=; b=QzIPkx+oqQyQPOwfUgZgys0/oxkmk5q2+WokO26kG26RXH65NH+5iC29lJe2wf+d9y g9yqBBl7OMkv5bI/h0lzJz6xWW+Knkya1cCX3sYfPLznPeomfDcwbxi5tO9syhmmhmKQ 36eaBWBgLy328nXUR6FCdyrYKXc5V/eLYz3awfMduONkqWznO3XuVuwF6Y2sWtjX98KL 5HiT8Tmd2ovtPFCN8sIPeGgqHK5tsEAEBqoBLEm/+gIiG9UovdvRzBFQCjbukUNvdOmL 2flLv1oA6slmN5WncQ2Uliv5XMV/pRxCXMfp/00lK2e2jkJZ4znk76Gq32Z4hgPAHarA 7xRw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1679480810; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=rV+vYVknDk0KS9H5P2B179jKwjCKWF8rdd5yxyHRKuo=; b=A5tF5Wu6w2KAAhV4aay97ioLrRbzUKmDXFlSrzRY8hu3TN1C590vdAnQwFx0Yk8ywO vRcF/d8uF5zYUlwloE/c1JAP+WfVq2icvG78VrlH6Bk0+4XK+ULvOG9jyAd/scpjyhfK o5o30ZTy5tnuNDxCHhUQzqlAxLi+dyEVp0fbaQzN8ubChuZstUGmY0PvnWXr99DOHvkg JYkEfG67hELc9qkUcuCHiBJ1gtQ37+MPp9qiGBbce+TbrtpWy31Y6jN4YiXzsT3hoD3X jxezC6+J9Cb3SRBBghmy/LgpYPlVxHk4cJo4jLh45/PTn0mM/hUJY0bQUtcd6TMLCA6f uhnw== X-Gm-Message-State: AO0yUKUDZ4pAEttvPXeIStMgMezJU1PjVzjamgQiXtWRztNWs8UqsUgW P2x+8wl9F1qJuXgwMDbBuaiyqNla49Owmf1M X-Google-Smtp-Source: AK7set+jiZ9T+xCL/qAD+ds36kfBJmBEquEjsYoU8MP91zaLr0mT03W2sgClc69mdtpNcgPv87PrHAuEYamQB8uH X-Received: from vdonnefort.c.googlers.com ([fda3:e722:ac3:cc00:28:9cb1:c0a8:2eea]) (user=vdonnefort job=sendgmr) by 2002:a05:6000:1149:b0:2cf:e388:7803 with SMTP id d9-20020a056000114900b002cfe3887803mr1136403wrx.3.1679480810492; Wed, 22 Mar 2023 03:26:50 -0700 (PDT) Date: Wed, 22 Mar 2023 10:22:43 +0000 In-Reply-To: <20230322102244.3239740-1-vdonnefort@google.com> Mime-Version: 1.0 References: <20230322102244.3239740-1-vdonnefort@google.com> X-Mailer: git-send-email 2.40.0.rc1.284.g88254d51c5-goog Message-ID: <20230322102244.3239740-2-vdonnefort@google.com> Subject: [PATCH v2 1/2] ring-buffer: Introducing ring-buffer mapping functions From: Vincent Donnefort To: rostedt@goodmis.org, mhiramat@kernel.org, linux-kernel@vger.kernel.org, linux-trace-kernel@vger.kernel.org Cc: kernel-team@android.com, Vincent Donnefort Precedence: bulk List-ID: X-Mailing-List: linux-trace-kernel@vger.kernel.org In preparation for allowing the user-space to map a ring-buffer, add a set of mapping functions: ring_buffer_{map,unmap}() ring_buffer_map_fault() And controls on the ring-buffer: ring_buffer_get_reader_page() /* swap reader and head */ ring_buffer_update_meta_page() Mapping the ring-buffer also involves: A unique ID for each page of the ring-buffer, as currently the pages are only identified through their in-kernel VA. A meta-page, where are stored statistics about the ring-buffer and a page IDs list, ordered. A field gives what page is the reader one and one to gives where the ring-buffer starts in the list of data pages. The linear mapping exposes the meta-page, and each page of the ring-buffer, ordered following their unique ID, assigned during the first mapping. Once mapped, no page can get in or out of the ring-buffer: the buffer size will remain unmodified and the splice enabling functions will in reality simply memcpy the data instead of swapping pages. Signed-off-by: Vincent Donnefort diff --git a/include/linux/ring_buffer.h b/include/linux/ring_buffer.h index 782e14f62201..4897e17ebdde 100644 --- a/include/linux/ring_buffer.h +++ b/include/linux/ring_buffer.h @@ -6,6 +6,8 @@ #include #include +#include + struct trace_buffer; struct ring_buffer_iter; @@ -211,4 +213,10 @@ int trace_rb_cpu_prepare(unsigned int cpu, struct hlist_node *node); #define trace_rb_cpu_prepare NULL #endif +int ring_buffer_map(struct trace_buffer *buffer, int cpu); +int ring_buffer_unmap(struct trace_buffer *buffer, int cpu); +struct page *ring_buffer_map_fault(struct trace_buffer *buffer, int cpu, + unsigned long pgoff); +int ring_buffer_get_reader_page(struct trace_buffer *buffer, int cpu); +int ring_buffer_update_meta_page(struct trace_buffer *buffer, int cpu); #endif /* _LINUX_RING_BUFFER_H */ diff --git a/include/uapi/linux/trace_mmap.h b/include/uapi/linux/trace_mmap.h new file mode 100644 index 000000000000..7794314a80e9 --- /dev/null +++ b/include/uapi/linux/trace_mmap.h @@ -0,0 +1,25 @@ +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ +#ifndef _UAPI_TRACE_MMAP_H_ +#define _UAPI_TRACE_MMAP_H_ + +#include + +#include + +struct ring_buffer_meta_page_header { +#if __BITS_PER_LONG == 64 + __u64 entries; + __u64 overrun; +#else + __u32 entries; + __u32 overrun; +#endif + __u32 pages_touched; + __u32 meta_page_size; + __u32 reader_page; /* page ID for the reader page */ + __u32 nr_data_pages; /* doesn't take into account the reader_page */ + __u32 data_page_head; /* ring-buffer head as an offset from data_start */ + __u32 data_start; /* offset within the meta page */ +}; + +#endif /* _UAPI_TRACE_MMAP_H_ */ diff --git a/kernel/trace/ring_buffer.c b/kernel/trace/ring_buffer.c index af50d931b020..8b9e773fef2e 100644 --- a/kernel/trace/ring_buffer.c +++ b/kernel/trace/ring_buffer.c @@ -332,6 +332,7 @@ struct buffer_page { local_t entries; /* entries on this page */ unsigned long real_end; /* real end of data */ struct buffer_data_page *page; /* Actual data page */ + u32 id; /* ID for external mapping */ }; /* @@ -489,6 +490,11 @@ typedef struct rb_time_struct rb_time_t; #define MAX_NEST 5 +struct ring_buffer_meta_page { + struct ring_buffer_meta_page_header hdr; + __u32 data_pages[]; +}; + /* * head_page == tail_page && head == tail then buffer is empty. */ @@ -529,6 +535,13 @@ struct ring_buffer_per_cpu { rb_time_t before_stamp; u64 event_stamp[MAX_NEST]; u64 read_stamp; + + int mapped; + int meta_order; + struct mutex mapping_lock; + unsigned long *page_ids; /* ID to addr */ + struct ring_buffer_meta_page *meta_page; + /* ring buffer pages to update, > 0 to add, < 0 to remove */ long nr_pages_to_update; struct list_head new_pages; /* new pages to add */ @@ -1452,12 +1465,38 @@ static inline void rb_inc_page(struct buffer_page **bpage) *bpage = list_entry(p, struct buffer_page, list); } +static inline void +rb_meta_page_head_move(struct ring_buffer_per_cpu *cpu_buffer, unsigned long num) +{ + struct ring_buffer_meta_page *meta = cpu_buffer->meta_page; + unsigned long head_id; + + if (!READ_ONCE(cpu_buffer->mapped)) + return; + + head_id = meta->hdr.data_page_head; + meta->hdr.data_page_head = (head_id + num) % cpu_buffer->nr_pages; +} + +static inline void +rb_meta_page_head_swap(struct ring_buffer_per_cpu *cpu_buffer) +{ + struct ring_buffer_meta_page *meta = cpu_buffer->meta_page; + + if (!READ_ONCE(cpu_buffer->mapped)) + return; + + meta->hdr.reader_page = cpu_buffer->head_page->id; + meta->data_pages[meta->hdr.data_page_head] = cpu_buffer->reader_page->id; +} + static struct buffer_page * rb_set_head_page(struct ring_buffer_per_cpu *cpu_buffer) { struct buffer_page *head; struct buffer_page *page; struct list_head *list; + unsigned long cnt = 0; int i; if (RB_WARN_ON(cpu_buffer, !cpu_buffer->head_page)) @@ -1479,9 +1518,12 @@ rb_set_head_page(struct ring_buffer_per_cpu *cpu_buffer) do { if (rb_is_head_page(page, page->list.prev)) { cpu_buffer->head_page = page; + rb_meta_page_head_move(cpu_buffer, cnt); + return page; } rb_inc_page(&page); + cnt++; } while (page != head); } @@ -1567,6 +1609,13 @@ static void rb_tail_page_update(struct ring_buffer_per_cpu *cpu_buffer, /* Again, either we update tail_page or an interrupt does */ (void)cmpxchg(&cpu_buffer->tail_page, tail_page, next_page); } + + if (READ_ONCE(cpu_buffer->mapped)) { + /* Ensure the meta_page is ready */ + smp_rmb(); + WRITE_ONCE(cpu_buffer->meta_page->hdr.pages_touched, + local_read(&cpu_buffer->pages_touched)); + } } static int rb_check_bpage(struct ring_buffer_per_cpu *cpu_buffer, @@ -1735,6 +1784,7 @@ rb_allocate_cpu_buffer(struct trace_buffer *buffer, long nr_pages, int cpu) init_irq_work(&cpu_buffer->irq_work.work, rb_wake_up_waiters); init_waitqueue_head(&cpu_buffer->irq_work.waiters); init_waitqueue_head(&cpu_buffer->irq_work.full_waiters); + mutex_init(&cpu_buffer->mapping_lock); bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()), GFP_KERNEL, cpu_to_node(cpu)); @@ -2173,7 +2223,6 @@ int ring_buffer_resize(struct trace_buffer *buffer, unsigned long size, /* prevent another thread from changing buffer sizes */ mutex_lock(&buffer->mutex); - if (cpu_id == RING_BUFFER_ALL_CPUS) { /* * Don't succeed if resizing is disabled, as a reader might be @@ -2523,6 +2572,13 @@ rb_handle_head_page(struct ring_buffer_per_cpu *cpu_buffer, local_sub(BUF_PAGE_SIZE, &cpu_buffer->entries_bytes); local_inc(&cpu_buffer->pages_lost); + if (READ_ONCE(cpu_buffer->mapped)) { + /* Ensure the meta_page is ready */ + smp_rmb(); + WRITE_ONCE(cpu_buffer->meta_page->hdr.overrun, + local_read(&cpu_buffer->overrun)); + } + /* * The entries will be zeroed out when we move the * tail page. @@ -3179,6 +3235,14 @@ static inline void rb_event_discard(struct ring_buffer_event *event) static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer) { local_inc(&cpu_buffer->entries); + + if (READ_ONCE(cpu_buffer->mapped)) { + /* Ensure the meta_page is ready */ + smp_rmb(); + WRITE_ONCE(cpu_buffer->meta_page->hdr.entries, + local_read(&cpu_buffer->entries)); + } + rb_end_commit(cpu_buffer); } @@ -3482,7 +3546,7 @@ static void check_buffer(struct ring_buffer_per_cpu *cpu_buffer, return; /* - * If this interrupted another event, + * If this interrupted another event, */ if (atomic_inc_return(this_cpu_ptr(&checking)) != 1) goto out; @@ -4643,7 +4707,9 @@ rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer) * Now make the new head point back to the reader page. */ rb_list_head(reader->list.next)->prev = &cpu_buffer->reader_page->list; + rb_meta_page_head_swap(cpu_buffer); rb_inc_page(&cpu_buffer->head_page); + rb_meta_page_head_move(cpu_buffer, 1); local_inc(&cpu_buffer->pages_read); @@ -5285,6 +5351,12 @@ rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer) cpu_buffer->lost_events = 0; cpu_buffer->last_overrun = 0; + if (READ_ONCE(cpu_buffer->mapped)) { + WRITE_ONCE(cpu_buffer->meta_page->hdr.entries, 0); + WRITE_ONCE(cpu_buffer->meta_page->hdr.pages_touched, 0); + WRITE_ONCE(cpu_buffer->meta_page->hdr.overrun, 0); + } + rb_head_page_activate(cpu_buffer); } @@ -5489,6 +5561,11 @@ int ring_buffer_swap_cpu(struct trace_buffer *buffer_a, cpu_buffer_a = buffer_a->buffers[cpu]; cpu_buffer_b = buffer_b->buffers[cpu]; + if (READ_ONCE(cpu_buffer_a->mapped) || READ_ONCE(cpu_buffer_b->mapped)) { + ret = -EBUSY; + goto out; + } + /* At least make sure the two buffers are somewhat the same */ if (cpu_buffer_a->nr_pages != cpu_buffer_b->nr_pages) goto out; @@ -5722,7 +5799,8 @@ int ring_buffer_read_page(struct trace_buffer *buffer, * Otherwise, we can simply swap the page with the one passed in. */ if (read || (len < (commit - read)) || - cpu_buffer->reader_page == cpu_buffer->commit_page) { + cpu_buffer->reader_page == cpu_buffer->commit_page || + READ_ONCE(cpu_buffer->mapped)) { struct buffer_data_page *rpage = cpu_buffer->reader_page->page; unsigned int rpos = read; unsigned int pos = 0; @@ -5839,6 +5917,306 @@ int ring_buffer_read_page(struct trace_buffer *buffer, } EXPORT_SYMBOL_GPL(ring_buffer_read_page); +#define META_PAGE_MAX_PAGES \ + ((PAGE_SIZE - (offsetof(struct ring_buffer_meta_page, data_pages))) >> 2) + +static void unmap_page(unsigned long addr) +{ + struct page *page = virt_to_page(addr); + + page->mapping = NULL; +} + +static void rb_free_page_ids(struct ring_buffer_per_cpu *cpu_buffer) +{ + int i; + + for (i = 0; i < cpu_buffer->nr_pages; i++) + unmap_page(cpu_buffer->page_ids[i]); + + kfree(cpu_buffer->page_ids); + cpu_buffer->page_ids = NULL; +} + +static int rb_alloc_meta_page(struct ring_buffer_per_cpu *cpu_buffer) +{ + struct page *meta_pages; + int pages; + int order = 0; + + if (cpu_buffer->meta_page) + return 0; + + if (cpu_buffer->nr_pages > META_PAGE_MAX_PAGES) { + /* Calculate how many more pages we need to hold indexes */ + pages = DIV_ROUND_UP(cpu_buffer->nr_pages - META_PAGE_MAX_PAGES, + PAGE_SIZE / sizeof(u32)); + /* Add back the meta_page itself */ + pages++; + order = fls(pages) - 1; + } + meta_pages = alloc_pages(GFP_USER, order); + if (!meta_pages) + return -ENOMEM; + + cpu_buffer->meta_page = page_to_virt(meta_pages); + cpu_buffer->meta_order = order; + + return 0; +} + +static void rb_free_meta_page(struct ring_buffer_per_cpu *cpu_buffer) +{ + unsigned long addr = (unsigned long)cpu_buffer->meta_page; + int i; + + for (i = 0; i < (1 << cpu_buffer->meta_order); i++) { + unmap_page(addr); + addr += PAGE_SIZE; + } + + free_pages((unsigned long)cpu_buffer->meta_page, cpu_buffer->meta_order); + cpu_buffer->meta_page = NULL; +} + +static void rb_setup_ids_meta_page(struct ring_buffer_per_cpu *cpu_buffer, + unsigned long *page_ids) +{ + struct ring_buffer_meta_page *meta = cpu_buffer->meta_page; + struct buffer_page *first_page, *bpage; + int data_page_end; + int id = 0; + + page_ids[id] = (unsigned long)cpu_buffer->reader_page->page; + cpu_buffer->reader_page->id = id++; + + /* Calculate the last index of data_pages[] */ + data_page_end = (1 << (cpu_buffer->meta_order + PAGE_SHIFT)) - + offsetof(struct ring_buffer_meta_page, data_pages); + data_page_end /= sizeof(u32); + + first_page = bpage = rb_set_head_page(cpu_buffer); + do { + if (id > data_page_end) { + WARN_ON(1); + break; + } + + page_ids[id] = (unsigned long)bpage->page; + bpage->id = id; + meta->data_pages[id - 1] = id; + + rb_inc_page(&bpage); + id++; + } while (bpage != first_page); + + /* install page ID to kern VA translation */ + cpu_buffer->page_ids = page_ids; + + meta->hdr.entries = 0; + meta->hdr.overrun = 0; + meta->hdr.pages_touched = 0; + meta->hdr.reader_page = cpu_buffer->reader_page->id; + meta->hdr.nr_data_pages = cpu_buffer->nr_pages; + meta->hdr.meta_page_size = 1 << (cpu_buffer->meta_order + PAGE_SHIFT); + meta->hdr.data_page_head = 0; + meta->hdr.data_start = offsetof(struct ring_buffer_meta_page, data_pages); +} + +static inline struct ring_buffer_per_cpu * +rb_get_mapped_buffer(struct trace_buffer *buffer, int cpu) +{ + struct ring_buffer_per_cpu *cpu_buffer; + + if (!cpumask_test_cpu(cpu, buffer->cpumask)) + return ERR_PTR(-EINVAL); + + cpu_buffer = buffer->buffers[cpu]; + + mutex_lock(&cpu_buffer->mapping_lock); + + if (!cpu_buffer->mapped) { + mutex_unlock(&cpu_buffer->mapping_lock); + return ERR_PTR(-ENODEV); + } + + return cpu_buffer; +} + +static inline void rb_put_mapped_buffer(struct ring_buffer_per_cpu *cpu_buffer) +{ + mutex_unlock(&cpu_buffer->mapping_lock); +} + +int ring_buffer_map(struct trace_buffer *buffer, int cpu) +{ + struct ring_buffer_per_cpu *cpu_buffer; + unsigned long flags, *page_ids; + int err = 0; + + if (!cpumask_test_cpu(cpu, buffer->cpumask)) + return -EINVAL; + + cpu_buffer = buffer->buffers[cpu]; + + mutex_lock(&cpu_buffer->mapping_lock); + + if (cpu_buffer->mapped) { + WRITE_ONCE(cpu_buffer->mapped, cpu_buffer->mapped + 1); + goto unlock; + } + + /* prevent another thread from changing buffer sizes */ + mutex_lock(&buffer->mutex); + atomic_inc(&cpu_buffer->resize_disabled); + mutex_unlock(&buffer->mutex); + + err = rb_alloc_meta_page(cpu_buffer); + if (err) { + atomic_dec(&cpu_buffer->resize_disabled); + goto unlock; + } + + /* page_ids include the reader page while nr_pages does not */ + page_ids = kzalloc(sizeof(*page_ids) * (cpu_buffer->nr_pages + 1), + GFP_KERNEL); + if (!page_ids) { + rb_free_meta_page(cpu_buffer); + atomic_dec(&cpu_buffer->resize_disabled); + err = -ENOMEM; + goto unlock; + } + + /* + * Lock all readers to block any page swap until the page IDs are + * assigned. + */ + raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags); + + rb_setup_ids_meta_page(cpu_buffer, page_ids); + /* + * Ensure the writer will observe the meta-page before + * cpu_buffer->mapped. + */ + smp_wmb(); + WRITE_ONCE(cpu_buffer->mapped, 1); + + /* Init meta_page values unless the writer did it already */ + cmpxchg(&cpu_buffer->meta_page->hdr.entries, 0, + local_read(&cpu_buffer->entries)); + cmpxchg(&cpu_buffer->meta_page->hdr.overrun, 0, + local_read(&cpu_buffer->overrun)); + cmpxchg(&cpu_buffer->meta_page->hdr.pages_touched, 0, + local_read(&cpu_buffer->pages_touched)); + + raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags); +unlock: + mutex_unlock(&cpu_buffer->mapping_lock); + + return err; +} + +int ring_buffer_unmap(struct trace_buffer *buffer, int cpu) +{ + struct ring_buffer_per_cpu *cpu_buffer; + int err = 0; + + if (!cpumask_test_cpu(cpu, buffer->cpumask)) + return -EINVAL; + + cpu_buffer = buffer->buffers[cpu]; + + mutex_lock(&cpu_buffer->mapping_lock); + + if (!cpu_buffer->mapped) { + err = -ENODEV; + goto unlock; + } + + WRITE_ONCE(cpu_buffer->mapped, cpu_buffer->mapped - 1); + if (!cpu_buffer->mapped) { + /* Wait the writer and readers to observe !mapped */ + synchronize_rcu(); + + rb_free_page_ids(cpu_buffer); + rb_free_meta_page(cpu_buffer); + atomic_dec(&cpu_buffer->resize_disabled); + } + +unlock: + mutex_unlock(&cpu_buffer->mapping_lock); + + return err; +} + +/* + * +--------------+ + * | meta page | pgoff=0 + * | ... | + * | | pgoff=(1<meta_order - 1) + * +--------------+ + * | data page1 | page_ids=0 + * +--------------+ + * | data page2 | page_ids=1 + * ... + */ +struct page *ring_buffer_map_fault(struct trace_buffer *buffer, int cpu, + unsigned long pgoff) +{ + struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu]; + + if (pgoff < (1 << cpu_buffer->meta_order)) + return virt_to_page((void *)cpu_buffer->meta_page + (pgoff << PAGE_SHIFT)); + + pgoff -= (1 << cpu_buffer->meta_order); + + if (pgoff > cpu_buffer->nr_pages) + return NULL; + + return virt_to_page(cpu_buffer->page_ids[pgoff]); +} + +int ring_buffer_get_reader_page(struct trace_buffer *buffer, int cpu) +{ + struct ring_buffer_per_cpu *cpu_buffer; + struct buffer_page *reader; + unsigned long flags; + + cpu_buffer = rb_get_mapped_buffer(buffer, cpu); + if (IS_ERR(cpu_buffer)) + return (int)PTR_ERR(cpu_buffer); + + raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags); + reader = cpu_buffer->reader_page; + reader->read = rb_page_size(reader); + if (!rb_per_cpu_empty(cpu_buffer)) + WARN_ON(!rb_get_reader_page(cpu_buffer)); + raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags); + + rb_put_mapped_buffer(cpu_buffer); + + return 0; +} + +int ring_buffer_update_meta_page(struct trace_buffer *buffer, int cpu) +{ + struct ring_buffer_per_cpu *cpu_buffer; + unsigned long flags; + + cpu_buffer = rb_get_mapped_buffer(buffer, cpu); + if (IS_ERR(cpu_buffer)) + return PTR_ERR(cpu_buffer); + + /* Update the head page if the writer moved it */ + raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags); + rb_set_head_page(cpu_buffer); + raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags); + + rb_put_mapped_buffer(cpu_buffer); + + return 0; +} + /* * We only allocate new buffers, never free them if the CPU goes down. * If we were to free the buffer, then the user would lose any trace that was in From patchwork Wed Mar 22 10:22:44 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Vincent Donnefort X-Patchwork-Id: 13183834 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 918B4C6FD1C for ; Wed, 22 Mar 2023 10:27:03 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230195AbjCVK1C (ORCPT ); Wed, 22 Mar 2023 06:27:02 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34704 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230194AbjCVK1B (ORCPT ); Wed, 22 Mar 2023 06:27:01 -0400 Received: from mail-wm1-x349.google.com (mail-wm1-x349.google.com [IPv6:2a00:1450:4864:20::349]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 16A025F220 for ; Wed, 22 Mar 2023 03:26:54 -0700 (PDT) Received: by mail-wm1-x349.google.com with SMTP id o7-20020a05600c4fc700b003edf85f6bb1so4322325wmq.3 for ; Wed, 22 Mar 2023 03:26:53 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; t=1679480812; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=wZ9f1BjLJkOFx0USqHh1WH8B1brZoQG0BbTDKoggwrY=; b=Ejct3CO8JsVUJdMjCYvwmgl3ejKMv9zBdrexMkafvTz3btw8DlF3TGWS8WHdbD8VEI 31NyEqErGFRnD56yw1XbEP0lsaAIMPQrI6HHtM4iO7xtaaUlOXNjGvFnKAV0/v5sDKsO BR82aJxENZcGtR4b0IxJE7lNVYuj98cYWUDUjv6x+Lf+MWz0z3y4BSv0EFigZ4MwHail KrgaMmTEh28dPxKa9ZeWsFmiFhjE61UW2NpoCRzbF9Z455wG0DqMKe5uQvAXFzUdkFNd nhD9lhGHM1InvN23fvM1Fg7BG04GOR9oZyyNpbbUaAejQ5hIgzn/pIjC5soMlOhwNn/V l+og== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1679480812; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=wZ9f1BjLJkOFx0USqHh1WH8B1brZoQG0BbTDKoggwrY=; b=c7HdQP2B+ufOS/H4JE9kxlZtAohaD7nuj5NkOGQPjB4R0ndReB2oy7FGCB5wHR0NNb SZS+lDheVj+wTV+3iO8+tf94YXsHfZcBMUzhjvO+ArJi3KcFZ8nfEN9EGYhR+lmr/1OF 0THBRaX7pBqUgpkvTTXB/u3pv2qMHJZXHTi2U829qanoEceTUObHPha5LgfB6wTFhGhN 1sRguyB3rcEhp4kFXWiVc0nBXfvV17bMqFAOevCPu90c58xKE3lb0yOwB1xpGJs4q6aA apds9Ir/oQFie6nGlp0jfUw3Yk1iaDaMh+HEGWpS/bZbiiTw3CUXioh1wxjTd25S6e7B cCKw== X-Gm-Message-State: AO0yUKXy7jbNSEdjsw07157zeWM0RJeSMeNvWMpRbFDrYtjanmJg8cbc Mmd9JcqzK3a7HVhmGQ0cbf1n0xcBSg8V4/qc X-Google-Smtp-Source: AK7set/jzeu/HzOtAk02LcoJyMCJOw0BLZu0S3oh+aO1r7aJsqhV5v9IafmheLKGw4WyyABB5MuVYzel/M/1+w+c X-Received: from vdonnefort.c.googlers.com ([fda3:e722:ac3:cc00:28:9cb1:c0a8:2eea]) (user=vdonnefort job=sendgmr) by 2002:a5d:534e:0:b0:2c5:557a:59b2 with SMTP id t14-20020a5d534e000000b002c5557a59b2mr1138478wrv.12.1679480812653; Wed, 22 Mar 2023 03:26:52 -0700 (PDT) Date: Wed, 22 Mar 2023 10:22:44 +0000 In-Reply-To: <20230322102244.3239740-1-vdonnefort@google.com> Mime-Version: 1.0 References: <20230322102244.3239740-1-vdonnefort@google.com> X-Mailer: git-send-email 2.40.0.rc1.284.g88254d51c5-goog Message-ID: <20230322102244.3239740-3-vdonnefort@google.com> Subject: [PATCH v2 2/2] tracing: Allow user-space mapping of the ring-buffer From: Vincent Donnefort To: rostedt@goodmis.org, mhiramat@kernel.org, linux-kernel@vger.kernel.org, linux-trace-kernel@vger.kernel.org Cc: kernel-team@android.com, Vincent Donnefort Precedence: bulk List-ID: X-Mailing-List: linux-trace-kernel@vger.kernel.org Currently, user-space extracts data from the ring-buffer via splice, which is handy for storage or network sharing. However, due to splice limitations, it is imposible to do real-time analysis without a copy. A solution for that problem is to let the user-space map the ring-buffer directly. The mapping exposed via the per-CPU file trace_pipe_raw. The first page is the meta-page and is followed by each page of the ring-buffer, ordered by their unique page ID. It is therefore easy to translate a page-ID to an offset in the mapping. * Meta-page -- include/uapi/linux/trace_mmap.h for a description * Page ID 0 * Page ID 1 ... The mapper must then do what use to be the kernel jobs: swap the reader with the head. This is done with a newly introduced ioctl: TRACE_MMAP_IOCTL_GET_READER_PAGE. Entries, pages_touched and overrun fields are automatically updated by the writer. Only readers keep the head page field updated. An additional ioctl TRACE_MMAP_IOCTL_UPDATE_META_PAGE allows to query that update, enabling non-consuming read from userspace. Signed-off-by: Vincent Donnefort diff --git a/include/uapi/linux/trace_mmap.h b/include/uapi/linux/trace_mmap.h index 7794314a80e9..c33adea0aa84 100644 --- a/include/uapi/linux/trace_mmap.h +++ b/include/uapi/linux/trace_mmap.h @@ -22,4 +22,7 @@ struct ring_buffer_meta_page_header { __u32 data_start; /* offset within the meta page */ }; +#define TRACE_MMAP_IOCTL_GET_READER_PAGE _IO('T', 0x1) +#define TRACE_MMAP_IOCTL_UPDATE_META_PAGE _IO('T', 0x2) + #endif /* _UAPI_TRACE_MMAP_H_ */ diff --git a/kernel/trace/trace.c b/kernel/trace/trace.c index 45551c7b4c36..65251a28f2a9 100644 --- a/kernel/trace/trace.c +++ b/kernel/trace/trace.c @@ -6399,7 +6399,7 @@ static void tracing_set_nop(struct trace_array *tr) { if (tr->current_trace == &nop_trace) return; - + tr->current_trace->enabled--; if (tr->current_trace->reset) @@ -8432,15 +8432,27 @@ tracing_buffers_splice_read(struct file *file, loff_t *ppos, return ret; } -/* An ioctl call with cmd 0 to the ring buffer file will wake up all waiters */ static long tracing_buffers_ioctl(struct file *file, unsigned int cmd, unsigned long arg) { struct ftrace_buffer_info *info = file->private_data; struct trace_iterator *iter = &info->iter; + switch (cmd) { + case TRACE_MMAP_IOCTL_GET_READER_PAGE: + return ring_buffer_get_reader_page(iter->array_buffer->buffer, + iter->cpu_file); + case TRACE_MMAP_IOCTL_UPDATE_META_PAGE: + return ring_buffer_update_meta_page(iter->array_buffer->buffer, + iter->cpu_file); + } + if (cmd) - return -ENOIOCTLCMD; + return -ENOTTY; + /* + * An ioctl call with cmd 0 to the ring buffer file will wake up all + * waiters + */ mutex_lock(&trace_types_lock); iter->wait_index++; @@ -8453,6 +8465,63 @@ static long tracing_buffers_ioctl(struct file *file, unsigned int cmd, unsigned return 0; } +static vm_fault_t tracing_buffers_mmap_fault(struct vm_fault *vmf) +{ + struct ftrace_buffer_info *info = vmf->vma->vm_file->private_data; + struct trace_iterator *iter = &info->iter; + vm_fault_t ret = VM_FAULT_SIGBUS; + struct page *page; + + page = ring_buffer_map_fault(iter->array_buffer->buffer, iter->cpu_file, + vmf->pgoff); + if (!page) + return ret; + + vmf->page = page; + + get_page(vmf->page); + vmf->page->mapping = vmf->vma->vm_file->f_mapping; + vmf->page->index = vmf->pgoff; + + return 0; +} + +static void tracing_buffers_mmap_close(struct vm_area_struct *vma) +{ + struct ftrace_buffer_info *info = vma->vm_file->private_data; + struct trace_iterator *iter = &info->iter; + + ring_buffer_unmap(iter->array_buffer->buffer, iter->cpu_file); +} + +static void tracing_buffers_mmap_open(struct vm_area_struct *vma) +{ + struct ftrace_buffer_info *info = vma->vm_file->private_data; + struct trace_iterator *iter = &info->iter; + + WARN_ON(ring_buffer_map(iter->array_buffer->buffer, iter->cpu_file)); +} + +static const struct vm_operations_struct tracing_buffers_vmops = { + .open = tracing_buffers_mmap_open, + .close = tracing_buffers_mmap_close, + .fault = tracing_buffers_mmap_fault, +}; + +static int tracing_buffers_mmap(struct file *filp, struct vm_area_struct *vma) +{ + struct ftrace_buffer_info *info = filp->private_data; + struct trace_iterator *iter = &info->iter; + + if (vma->vm_flags & VM_WRITE) + return -EPERM; + + vm_flags_mod(vma, VM_DONTCOPY | VM_DONTDUMP, VM_MAYWRITE); + vma->vm_ops = &tracing_buffers_vmops; + + return ring_buffer_map(iter->array_buffer->buffer, iter->cpu_file); +} + static const struct file_operations tracing_buffers_fops = { .open = tracing_buffers_open, .read = tracing_buffers_read, @@ -8461,6 +8530,7 @@ static const struct file_operations tracing_buffers_fops = { .splice_read = tracing_buffers_splice_read, .unlocked_ioctl = tracing_buffers_ioctl, .llseek = no_llseek, + .mmap = tracing_buffers_mmap, }; static ssize_t