From nobody Mon Feb 9 18:21:33 2026 Received: from mail-wr1-f74.google.com (mail-wr1-f74.google.com [209.85.221.74]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 7614C1B0F31 for ; Fri, 16 May 2025 13:40:54 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.74 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1747402857; cv=none; b=iBp3V/mbI9/IiQxgkxycg63raqEmaqT3BuiPWGjpyc27nWIsAz//e4x+XK+wOewuFb9IGURdFDQj10WuFP2TBx5XohPf9WTW2z2QOELk384/BPbVye9TQ+ZKp/SDHpe2zXgKR8UHWB1kJFG0yjdPdjXQ643Vr5cx4zXnyjGEONs= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1747402857; c=relaxed/simple; bh=5ANey67rL62eoifHe2Xw8aVJ25yXPuZsRZgsyC0d2wc=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=HaYI3dpbXgUytXhyKqBkABXAVHa8bvoil6CJXhZP3CIUl4dkHSJDcAyIb5WwQKx+hkRVmYTAXWNSBu+UjKqmgp1Plf1pgsowmz35QWyLcvnMqwmw3z8RWBJbconvf37h7aOzqz7wvtn1YDXwbwNaRWcw7DCk9G27KzKYhVeRs0s= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--vdonnefort.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=Qv3t3SEk; arc=none smtp.client-ip=209.85.221.74 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--vdonnefort.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="Qv3t3SEk" Received: by mail-wr1-f74.google.com with SMTP id ffacd0b85a97d-3a0b63ca572so1591915f8f.0 for ; Fri, 16 May 2025 06:40:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1747402853; x=1748007653; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=3l7sH1g5b7MpFTAKIwgcg969poSDjgkc3BaR0DDvsW0=; b=Qv3t3SEkA10svq0CRZHNaFkCKlYyJxzN2mqccVmIroxmA+eIdRYWG+clpLZl3BFegy /RrODyp9e93L5jzErNgqtZrD/sbuBDBxqUCLzEv4MSGHUZo/7kLa8NP5QA9q2X02yLPQ /W8TM+xIwkGRtHwLYBqMeoETgrLqTK0vnCmdLK5siziYldAQjJsd/omP1cu2nVdOVkSS KjWwxLYzFnbIhbA41vJDY1LmSnapv1vFAuNPY7fpC60iMWPCdtLOvXv9B5Md8uybFPgp QCy4gk5gK6l1y/vDWKFNrnXZgS3eFDYbk6FPwOIyBP/1zIyex8d1FhEIvO2Xkxd26UD/ snXA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1747402853; x=1748007653; 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=3l7sH1g5b7MpFTAKIwgcg969poSDjgkc3BaR0DDvsW0=; b=v/qaXUmEZuiWArauU6eM+V9wShwHNmDxrE4aMIXo1CPqcktELJtIPH51C8aKFJVn4K XaKiPzKnWEV6ARqeIWcM3gBTclGLKeKGfe8g8hcfhv6tV6RMd6C9rDmRLr7UCB6kgflx +Sgq1jHiff6AHHPojHsJXuuJy9zZv/ZAROZSt8JSTQPsibnhHbAU5pyPHDewdUooEK4U XnzIaB8D+i58RsDUikxCGvagn4FWfXWGKmH4c8msuN9tI5yGjb82QCh7/X/3XJYSWngJ Zvy+CnEXauY9EBb9YfxNHMUSvkzG2ARTBecCe9bqFqBpBzo8rShNdhxdNHnv3ryyweOp 8j0w== X-Forwarded-Encrypted: i=1; AJvYcCW6b8RzhF/hSqk3yDLQ4hnxzV46xFdb7k3f/nz6h4Kfr4vSrnm2RV1h2PvEIEEUkh7ugnumy67rKKJgyPw=@vger.kernel.org X-Gm-Message-State: AOJu0Yxp756EVpbpAOsXUbeAeW5BQtZMTjYNI5RZF3Fzd+MN44LNr99B dVny1futGBTu8wpfS57/Dk1lLb1NMs33+ZPqyGVyfMx2utr7VomvhAFykRAhxwsQWAvLEqRzIMe +wWjHmQCVvmFTYst1CYV9EA== X-Google-Smtp-Source: AGHT+IHSvXG31EJosFyPI0TXKjX99Gq2NrFMKey/ycQIzUi0T4UYVrMK+GRbmIiPzSgqGaMAJo8P9eavP89YX9yc X-Received: from wmpz15.prod.google.com ([2002:a05:600c:a0f:b0:442:f984:ed5e]) (user=vdonnefort job=prod-delivery.src-stubby-dispatcher) by 2002:a05:6000:2012:b0:3a0:b58c:dd8 with SMTP id ffacd0b85a97d-3a35c82fa3bmr3176886f8f.30.1747402852922; Fri, 16 May 2025 06:40:52 -0700 (PDT) Date: Fri, 16 May 2025 14:40:16 +0100 In-Reply-To: <20250516134031.661124-1-vdonnefort@google.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20250516134031.661124-1-vdonnefort@google.com> X-Mailer: git-send-email 2.49.0.1101.gccaa498523-goog Message-ID: <20250516134031.661124-11-vdonnefort@google.com> Subject: [PATCH v5 10/25] tracing: Introduce simple_ring_buffer From: Vincent Donnefort To: rostedt@goodmis.org, mhiramat@kernel.org, mathieu.desnoyers@efficios.com, linux-trace-kernel@vger.kernel.org, maz@kernel.org, oliver.upton@linux.dev, joey.gouly@arm.com, suzuki.poulose@arm.com, yuzenghui@huawei.com Cc: kvmarm@lists.linux.dev, linux-arm-kernel@lists.infradead.org, jstultz@google.com, qperret@google.com, will@kernel.org, kernel-team@android.com, linux-kernel@vger.kernel.org, Vincent Donnefort Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Add a simple implementation of the kernel ring-buffer. This intends to be used later by ring-buffer remotes such as the pKVM hypervisor, hence the need for a cut down version (write only) without any dependency. Signed-off-by: Vincent Donnefort diff --git a/include/linux/simple_ring_buffer.h b/include/linux/simple_ring= _buffer.h new file mode 100644 index 000000000000..d6761dc2f404 --- /dev/null +++ b/include/linux/simple_ring_buffer.h @@ -0,0 +1,50 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +#ifndef _LINUX_SIMPLE_RING_BUFFER_H +#define _LINUX_SIMPLE_RING_BUFFER_H + +#include +#include +#include +#include + +/* + * Ideally those struct would stay private but the caller needs to know ho= w big they are to allocate + * the memory for simple_ring_buffer_init(). + */ +struct simple_buffer_page { + struct list_head list; + struct buffer_data_page *page; + u64 entries; + u32 write; + u32 id; +}; + +struct simple_rb_per_cpu { + struct simple_buffer_page *tail_page; + struct simple_buffer_page *reader_page; + struct simple_buffer_page *head_page; + struct simple_buffer_page *bpages; + struct trace_buffer_meta *meta; + u32 nr_pages; + +#define SIMPLE_RB_UNAVAILABLE 0 +#define SIMPLE_RB_READY 1 +#define SIMPLE_RB_WRITING 2 + u32 status; + + u64 last_overrun; + u64 write_stamp; + + struct simple_rb_cbs *cbs; +}; + +void *simple_ring_buffer_reserve(struct simple_rb_per_cpu *cpu_buffer, uns= igned long length, + u64 timestamp); +void simple_ring_buffer_commit(struct simple_rb_per_cpu *cpu_buffer); +void simple_ring_buffer_unload(struct simple_rb_per_cpu *cpu_buffer); +int simple_ring_buffer_init(struct simple_rb_per_cpu *cpu_buffer, struct s= imple_buffer_page *bpages, + const struct ring_buffer_desc *desc); +int simple_ring_buffer_enable_tracing(struct simple_rb_per_cpu *cpu_buffer= , bool enable); +int simple_ring_buffer_swap_reader_page(struct simple_rb_per_cpu *cpu_buff= er); +int simple_ring_buffer_reset(struct simple_rb_per_cpu *cpu_buffer); +#endif diff --git a/kernel/trace/Kconfig b/kernel/trace/Kconfig index 2fcc86c7fe7e..407cb05cc8a0 100644 --- a/kernel/trace/Kconfig +++ b/kernel/trace/Kconfig @@ -1218,4 +1218,7 @@ source "kernel/trace/rv/Kconfig" config TRACE_REMOTE bool =20 +config SIMPLE_RING_BUFFER + bool + endif # FTRACE diff --git a/kernel/trace/Makefile b/kernel/trace/Makefile index b8204ae93744..cece10b1f97c 100644 --- a/kernel/trace/Makefile +++ b/kernel/trace/Makefile @@ -111,4 +111,5 @@ obj-$(CONFIG_TRACEPOINT_BENCHMARK) +=3D trace_benchmark= .o obj-$(CONFIG_RV) +=3D rv/ =20 obj-$(CONFIG_TRACE_REMOTE) +=3D trace_remote.o +obj-$(CONFIG_SIMPLE_RING_BUFFER) +=3D simple_ring_buffer.o libftrace-y :=3D ftrace.o diff --git a/kernel/trace/simple_ring_buffer.c b/kernel/trace/simple_ring_b= uffer.c new file mode 100644 index 000000000000..3efdb895d77a --- /dev/null +++ b/kernel/trace/simple_ring_buffer.c @@ -0,0 +1,360 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Copyright (C) 2025 - Google LLC + * Author: Vincent Donnefort + */ + +#include +#include + +#include +#include + +#define SIMPLE_RB_LINK_HEAD 1UL +#define SIMPLE_RB_LINK_MASK ~SIMPLE_RB_LINK_HEAD + +static void simple_bpage_set_head_link(struct simple_buffer_page *bpage) +{ + unsigned long link =3D (unsigned long)bpage->list.next; + + link &=3D SIMPLE_RB_LINK_MASK; + link |=3D SIMPLE_RB_LINK_HEAD; + + /* + * Paired with simple_bpage_is_head() to order access between the head li= nk and overrun. It + * ensures we always report an up-to-date value after swapping the reader= page. + */ + smp_store_release(&bpage->list.next, (struct list_head *)link); +} + +static bool simple_bpage_is_head(struct simple_buffer_page *bpage) +{ + unsigned long link =3D (unsigned long)smp_load_acquire(&bpage->list.prev-= >next); + + return link & SIMPLE_RB_LINK_HEAD; +} + +static bool simple_bpage_unset_head_link(struct simple_buffer_page *bpage, + struct simple_buffer_page *dst) +{ + unsigned long *link =3D (unsigned long *)(&bpage->list.next); + unsigned long old =3D (*link & SIMPLE_RB_LINK_MASK) | SIMPLE_RB_LINK_HEAD; + unsigned long new =3D (unsigned long)(&dst->list); + + return try_cmpxchg(link, &old, new); +} + +static struct simple_buffer_page *simple_bpage_from_link(struct list_head = *list) +{ + unsigned long ptr =3D (unsigned long)list & SIMPLE_RB_LINK_MASK; + + return container_of((struct list_head *)ptr, struct simple_buffer_page, l= ist); +} + +static struct simple_buffer_page *simple_bpage_next_page(struct simple_buf= fer_page *bpage) +{ + return simple_bpage_from_link(bpage->list.next); +} + +static void simple_bpage_reset(struct simple_buffer_page *bpage) +{ + bpage->write =3D 0; + bpage->entries =3D 0; + + local_set(&bpage->page->commit, 0); +} + +static void simple_bpage_init(struct simple_buffer_page *bpage, unsigned l= ong page) +{ + INIT_LIST_HEAD(&bpage->list); + bpage->page =3D (struct buffer_data_page *)page; + + simple_bpage_reset(bpage); +} + +#define simple_rb_meta_inc(__meta, __inc) \ + WRITE_ONCE((__meta), (__meta + __inc)) + +static bool simple_rb_loaded(struct simple_rb_per_cpu *cpu_buffer) +{ + return !!cpu_buffer->bpages; +} + +int simple_ring_buffer_swap_reader_page(struct simple_rb_per_cpu *cpu_buff= er) +{ + struct simple_buffer_page *last, *head, *reader; + unsigned long overrun; + + if (!simple_rb_loaded(cpu_buffer)) + return -ENODEV; + + head =3D cpu_buffer->head_page; + reader =3D cpu_buffer->reader_page; + + do { + /* Run after the writer to find the head */ + if (!simple_bpage_is_head(head)) + head =3D simple_bpage_next_page(head); + + /* Connect the reader page around the header page */ + reader->list.next =3D head->list.next; + reader->list.prev =3D head->list.prev; + + /* The last page before the head */ + last =3D simple_bpage_from_link(head->list.prev); + + /* The reader page points to the new header page */ + simple_bpage_set_head_link(reader); + + overrun =3D cpu_buffer->meta->overrun; + } while (!simple_bpage_unset_head_link(last, reader)); + + cpu_buffer->head_page =3D simple_bpage_from_link(reader->list.next); + cpu_buffer->head_page->list.prev =3D &reader->list; + cpu_buffer->reader_page =3D head; + cpu_buffer->meta->reader.lost_events =3D overrun - cpu_buffer->last_overr= un; + cpu_buffer->meta->reader.id =3D cpu_buffer->reader_page->id; + cpu_buffer->last_overrun =3D overrun; + + return 0; +} + +static struct simple_buffer_page *simple_rb_move_tail(struct simple_rb_per= _cpu *cpu_buffer) +{ + struct simple_buffer_page *tail, *new_tail; + + tail =3D cpu_buffer->tail_page; + new_tail =3D simple_bpage_next_page(tail); + + if (simple_bpage_unset_head_link(tail, new_tail)) { + /* + * Oh no! we've caught the head. There is none anymore and swap_reader w= ill spin + * until we set the new one. Overrun must be written first, to make sure= we report + * the correct number of lost events. + */ + simple_rb_meta_inc(cpu_buffer->meta->overrun, new_tail->entries); + simple_rb_meta_inc(cpu_buffer->meta->pages_lost, 1); + + simple_bpage_set_head_link(new_tail); + } + + simple_bpage_reset(new_tail); + cpu_buffer->tail_page =3D new_tail; + + simple_rb_meta_inc(cpu_buffer->meta->pages_touched, 1); + + return new_tail; +} + +static unsigned long rb_event_size(unsigned long length) +{ + struct ring_buffer_event *event; + + return length + RB_EVNT_HDR_SIZE + sizeof(event->array[0]); +} + +static struct ring_buffer_event * +rb_event_add_ts_extend(struct ring_buffer_event *event, u64 delta) +{ + event->type_len =3D RINGBUF_TYPE_TIME_EXTEND; + event->time_delta =3D delta & TS_MASK; + event->array[0] =3D delta >> TS_SHIFT; + + return (struct ring_buffer_event *)((unsigned long)event + 8); +} + +static struct ring_buffer_event * +simple_rb_reserve_next(struct simple_rb_per_cpu *cpu_buffer, unsigned long= length, u64 timestamp) +{ + unsigned long ts_ext_size =3D 0, event_size =3D rb_event_size(length); + struct simple_buffer_page *tail =3D cpu_buffer->tail_page; + struct ring_buffer_event *event; + u32 write, prev_write; + u64 time_delta; + + time_delta =3D timestamp - cpu_buffer->write_stamp; + + if (test_time_stamp(time_delta)) + ts_ext_size =3D 8; + + prev_write =3D tail->write; + write =3D prev_write + event_size + ts_ext_size; + + if (unlikely(write > (PAGE_SIZE - BUF_PAGE_HDR_SIZE))) + tail =3D simple_rb_move_tail(cpu_buffer); + + if (!tail->entries) { + tail->page->time_stamp =3D timestamp; + time_delta =3D 0; + ts_ext_size =3D 0; + write =3D event_size; + prev_write =3D 0; + } + + tail->write =3D write; + tail->entries++; + + cpu_buffer->write_stamp =3D timestamp; + + event =3D (struct ring_buffer_event *)(tail->page->data + prev_write); + if (ts_ext_size) { + event =3D rb_event_add_ts_extend(event, time_delta); + time_delta =3D 0; + } + + event->type_len =3D 0; + event->time_delta =3D time_delta; + event->array[0] =3D event_size - RB_EVNT_HDR_SIZE; + + return event; +} + +void *simple_ring_buffer_reserve(struct simple_rb_per_cpu *cpu_buffer, uns= igned long length, + u64 timestamp) +{ + struct ring_buffer_event *rb_event; + + if (cmpxchg(&cpu_buffer->status, SIMPLE_RB_READY, SIMPLE_RB_WRITING) !=3D= SIMPLE_RB_READY) + return NULL; + + rb_event =3D simple_rb_reserve_next(cpu_buffer, length, timestamp); + + return &rb_event->array[1]; +} + +void simple_ring_buffer_commit(struct simple_rb_per_cpu *cpu_buffer) +{ + local_set(&cpu_buffer->tail_page->page->commit, + cpu_buffer->tail_page->write); + simple_rb_meta_inc(cpu_buffer->meta->entries, 1); + + /* + * Paired with simple_rb_enable_tracing() to ensure data is + * written to the ring-buffer before teardown. + */ + smp_store_release(&cpu_buffer->status, SIMPLE_RB_READY); +} + +static u32 simple_rb_enable_tracing(struct simple_rb_per_cpu *cpu_buffer, = bool enable) +{ + u32 prev_status; + + if (enable) + return cmpxchg(&cpu_buffer->status, SIMPLE_RB_UNAVAILABLE, SIMPLE_RB_REA= DY); + + /* Wait for the buffer to be released */ + do { + prev_status =3D cmpxchg_acquire(&cpu_buffer->status, + SIMPLE_RB_READY, + SIMPLE_RB_UNAVAILABLE); + } while (prev_status =3D=3D SIMPLE_RB_WRITING); + + return prev_status; +} + +int simple_ring_buffer_reset(struct simple_rb_per_cpu *cpu_buffer) +{ + struct simple_buffer_page *bpage; + u32 prev_status; + + if (!simple_rb_loaded(cpu_buffer)) + return -ENODEV; + + prev_status =3D simple_rb_enable_tracing(cpu_buffer, false); + + while (!simple_bpage_is_head(cpu_buffer->head_page)) + cpu_buffer->head_page =3D simple_bpage_next_page(cpu_buffer->head_page); + + bpage =3D cpu_buffer->tail_page =3D cpu_buffer->head_page; + do { + simple_bpage_reset(bpage); + bpage =3D simple_bpage_next_page(bpage); + } while (bpage !=3D cpu_buffer->head_page); + + simple_bpage_reset(cpu_buffer->reader_page); + + cpu_buffer->last_overrun =3D 0; + cpu_buffer->write_stamp =3D 0; + + cpu_buffer->meta->reader.read =3D 0; + cpu_buffer->meta->reader.lost_events =3D 0; + cpu_buffer->meta->entries =3D 0; + cpu_buffer->meta->overrun =3D 0; + cpu_buffer->meta->read =3D 0; + cpu_buffer->meta->pages_lost =3D 0; + cpu_buffer->meta->pages_touched =3D 0; + + if (prev_status =3D=3D SIMPLE_RB_READY) + simple_rb_enable_tracing(cpu_buffer, true); + + return 0; +} + +int simple_ring_buffer_init(struct simple_rb_per_cpu *cpu_buffer, struct s= imple_buffer_page *bpages, + const struct ring_buffer_desc *desc) +{ + struct simple_buffer_page *bpage =3D bpages; + int i; + + /* At least 1 reader page and one head */ + if (desc->nr_page_va < 2) + return -EINVAL; + + memset(cpu_buffer, 0, sizeof(*cpu_buffer)); + + cpu_buffer->bpages =3D bpages; + + cpu_buffer->meta =3D (void *)desc->meta_va; + memset(cpu_buffer->meta, 0, sizeof(*cpu_buffer->meta)); + cpu_buffer->meta->meta_page_size =3D PAGE_SIZE; + cpu_buffer->meta->nr_subbufs =3D cpu_buffer->nr_pages; + + /* The reader page is not part of the ring initially */ + simple_bpage_init(bpage, desc->page_va[0]); + bpage->id =3D 0; + + cpu_buffer->nr_pages =3D 1; + + cpu_buffer->reader_page =3D bpage; + cpu_buffer->tail_page =3D bpage + 1; + cpu_buffer->head_page =3D bpage + 1; + + for (i =3D 1; i < desc->nr_page_va; i++) { + simple_bpage_init(++bpage, desc->page_va[i]); + + bpage->list.next =3D &(bpage + 1)->list; + bpage->list.prev =3D &(bpage - 1)->list; + bpage->id =3D i; + + cpu_buffer->nr_pages =3D i + 1; + } + + /* Close the ring */ + bpage->list.next =3D &cpu_buffer->tail_page->list; + cpu_buffer->tail_page->list.prev =3D &bpage->list; + + /* The last init'ed page points to the head page */ + simple_bpage_set_head_link(bpage); + + return 0; +} + +void simple_ring_buffer_unload(struct simple_rb_per_cpu *cpu_buffer) +{ + if (!simple_rb_loaded(cpu_buffer)) + return; + + simple_rb_enable_tracing(cpu_buffer, false); + + cpu_buffer->bpages =3D 0; +} + +int simple_ring_buffer_enable_tracing(struct simple_rb_per_cpu *cpu_buffer= , bool enable) +{ + if (!simple_rb_loaded(cpu_buffer)) + return -ENODEV; + + simple_rb_enable_tracing(cpu_buffer, enable); + + return 0; +} --=20 2.49.0.1101.gccaa498523-goog