diff options
| author | Vincent Donnefort <vdonnefort@google.com> | 2026-09-08 10:09:35 +0100 |
|---|---|---|
| committer | Steven Rostedt <rostedt@goodmis.org> | 2026-10-15 18:28:41 -0400 |
| commit | 4b0c4fb9bc51282e2cf895b838c533f364c2e7a1 (patch) | |
| tree | 5ff2b43ef78af3e927c1170adae0a9ff92de242b /kernel/trace/ring_buffer.c | |
| parent | 084100a1b579e6e08085dfc33caa4df31bb25696 (diff) | |
ring-buffer: Rename ring_buffer_size() to ring_buffer_capacity()
Since commit 8a5f63637890 ("ring-buffer: Fix subbuf resize race with
ring buffer readers"), "capacity" refers to the memory available for
events (excluding subbuffer headers) while "size" refers to the raw
allocation. ring_buffer_size() actually calculates this event capacity.
Rename it to ring_buffer_capacity() to align with this convention.
Link: https://patch.msgid.link/20260908090937.838544-2-vdonnefort@google.com
Signed-off-by: Vincent Donnefort <vdonnefort@google.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
Diffstat (limited to 'kernel/trace/ring_buffer.c')
| -rw-r--r-- | kernel/trace/ring_buffer.c | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/kernel/trace/ring_buffer.c b/kernel/trace/ring_buffer.c index 04bb94c29f58..289bae003d7f 100644 --- a/kernel/trace/ring_buffer.c +++ b/kernel/trace/ring_buffer.c @@ -6546,18 +6546,23 @@ void ring_buffer_iter_advance(struct ring_buffer_iter *iter) EXPORT_SYMBOL_GPL(ring_buffer_iter_advance); /** - * ring_buffer_size - return the size of the ring buffer (in bytes) + * ring_buffer_capacity - return the capacity of the ring buffer (in bytes) * @buffer: The ring buffer. - * @cpu: The CPU to get ring buffer size from. + * @cpu: The CPU to get ring buffer capacity from. + * + * Capacity is the total memory available for recording event data in the + * ring buffer. It excludes subbuffer headers. + * + * Returns the capacity in bytes, or 0 if the CPU is not set in the buffer mask. */ -unsigned long ring_buffer_size(struct trace_buffer *buffer, int cpu) +unsigned long ring_buffer_capacity(struct trace_buffer *buffer, int cpu) { if (!cpumask_test_cpu(cpu, buffer->cpumask)) return 0; return rb_subbuf_capacity(buffer) * buffer->buffers[cpu]->nr_pages; } -EXPORT_SYMBOL_GPL(ring_buffer_size); +EXPORT_SYMBOL_GPL(ring_buffer_capacity); /** * ring_buffer_max_event_size - return the max data size of an event |