Skip to content

ring-buffer/tracing: Allow ring buffer to have bigger sub buffers

Steven Rostedt linux-trace-kernel lkml 5 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v5 Latest15 patches 20 repliesIn review
  2. v415 patches 0 repliesSuperseded
  3. v315 patches 0 repliesSuperseded
Earlier versions · 2
VersionPostedPatchesRepliesStatus
v215 patches0 repliesSuperseded
v114 patches5 repliesSuperseded

Patches in v5 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/15ring-buffer: Refactor ring buffer implementationkernel/trace/ring_buffer.c+30 -302 replies
2/15ring-buffer: Page size per ring bufferinclude/linux/ring_buffer.h kernel/trace/ring_buffer.c kernel/trace/trace.c +2 more+86 -466 replies
3/15ring-buffer: Add interface for configuring trace sub buffer sizeinclude/linux/ring_buffer.h kernel/trace/ring_buffer.c kernel/trace/trace.c+125 -03 replies
4/15ring-buffer: Set new size of the ring buffer sub pagekernel/trace/ring_buffer.c+73 -73 replies
5/15ring-buffer: Read and write to ring buffers with custom sub buffer sizeinclude/linux/ring_buffer.h kernel/trace/ring_buffer.c kernel/trace/ring_buffer_benchmark.c +1 more+89 -410 replies
6/15ring-buffer: Clear pages on error in ring_buffer_subbuf_order_set() failurekernel/trace/ring_buffer.c+1 -02 replies
7/15ring-buffer: Do no swap cpu buffers if order is differentkernel/trace/ring_buffer.c+3 -00 replies
8/15ring-buffer: Make sure the spare sub buffer used for reads has same sizekernel/trace/trace.c+11 -00 replies
9/15tracing: Update snapshot order along with main buffer orderkernel/trace/trace.c+43 -20 replies
10/15tracing: Stop the tracing while changing the ring buffer subbuf sizekernel/trace/trace.c+10 -30 replies
11/15ring-buffer: Keep the same size when updating the orderkernel/trace/ring_buffer.c+4 -10 replies
12/15ring-buffer: Just update the subbuffers when changing their allocation orderkernel/trace/ring_buffer.c+71 -170 replies
13/15ring-buffer: Add documentation on the buffer_subbuf_order fileDocumentation/trace/ftrace.rst+27 -00 replies
14/15ringbuffer/selftest: Add basic selftest to test changing subbuf ordertools/testing/selftests/ftrace/test.d/00basic/ringbuffer_order.tc+95 -01 reply
15/15tracing: Update subbuffer with kilobytes not page orderDocumentation/trace/ftrace.rst kernel/trace/trace.c tools/testing/selftests/ftrace/test.d/00basic/ringbuffer_subbuf_size.tc+54 -482 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v5 yet.

Read the v5 thread

Cover letter [PATCH v5 00/15] ring-buffer/tracing: Allow ring buffer to have bigger sub buffers

Note, this has been on my todo list since the ring buffer was created back in 2008.

Tzvetomir last worked on this in 2021 and I need to finally get it in.

His last series was:

https://lore.kernel.org/linux-trace-devel/[email protected]/

With the description of:

Currently the size of one sub buffer page is global for all buffers and it is hard coded to one system page. The patch set introduces configurable ring buffer sub page size, per ring buffer. A new user space interface is introduced, which allows to change the sub page size of the ftrace buffer, per ftrace instance.

I'm pulling in his patches mostly untouched, except that I had to tweak a few things to forward port them.

The issues I found I added as the last 7 patches to the series, and then I added documentation and a selftest, and then changed the UI file from buffer_subbuf_order to buffer_subbuf_size_kb.

Basically, events to the tracing subsystem are limited to just under a PAGE_SIZE, as the ring buffer is split into "sub buffers" of one page size, and an event can not be bigger than a sub buffer. This allows users to change the size of a sub buffer by the order:

echo 3 > /sys/kernel/tracing/buffer_subbuf_order

[
last patch updates this to:

echo 32 > /sys/kernel/tracing/buffer_subbuf_size_kb

]

Will make each sub buffer a size of 8 pages (32KB), allowing events to be almost as big as 8 pages in size (sub buffers do have meta data on them as well, keeping an event from reaching the same size as a sub buffer).

Changes since v4: https://lore.kernel.org/linux-trace-kernel/[email protected]/

- Rebase on latest trace/core

- Fixed a kerneldoc issues reported by kernel test robot

Changes since v3: https://lore.kernel.org/all/[email protected]/

- Rebase on trace/core:

https://git.kernel.org/pub/scm/linux/kernel/git/trace/linux-trace.git/commit/?h=trace/core&id=59c28cc95f0a9f5556561e2416af4ecf86184b71

Changes since v2: https://lore.kernel.org/all/[email protected]/

- Fixed up the subbuf tests to ignore multiple spaces after before the 'buf' string (same fix as was done for the trace_marker test).

- This time include Cc'ing linux-trace-kernel :-p

Changes since v1: https://lore.kernel.org/all/[email protected]/

- Add the last patch that changes the ABI from a file called:

buffer_subbuf_order to buffer_subbuf_size_kb

That is, I kept the old interface the same, but then added the last patch that converts the interface into the one that makes more sense. I like keeping this in the git history, especially because of the way the implemantion is.

- I rebased on top of trace/core in the:

git://git.kernel.org/pub/scm/linux/kernel/git/trace/linux-trace.git

- I made the tests a bit more advanced. Still a smoke test, but it now checks if the string written is the same as the string read.