[PATCH printk v4 0/6] printk: reimplement LOG_CONT handling

From: John Ogness
Date: Tue Sep 08 2020 - 16:29:43 EST


Here is v4 for the second series to rework the printk subsystem.
(The v3 is here [0].) This series implements a new ringbuffer
feature that allows the last record to be extended. Petr Mladek
provided the initial proof of concept [1] for this.

Using the record extension feature, LOG_CONT is re-implemented
in a way that exactly preserves its behavior, but avoids the
need for an extra buffer. In particular, it avoids the need for
any synchronization that such a buffer requires.

This series deviates from the agreements [2] made at the meeting
during LPC2019 in Lisbon. The test results of the v1 series,
which implemented LOG_CONT as agreed upon, showed that the
effects on existing userspace tools using /dev/kmsg (journalctl,
dmesg) were not acceptable [3].

Patch 5 introduces *four* new memory barrier pairs. Two of them
are insignificant additions (data_realloc:A/desc_read:D and
data_realloc:A/data_push_tail:B) because they are alternate path
memory barriers that exactly match the purpose and context of
the two existing memory barrier pairs they provide an alternate
path for. The other two new memory barrier pairs are significant

desc_reopen_last:A / _prb_commit:B - When reopening a descriptor,
ensure the state transitions back to desc_reserved before
fully trusting the descriptor data.

_prb_commit:B / desc_reserve:D - When committing a descriptor,
ensure the state transitions to desc_committed before checking
the head ID to see if the descriptor needs to be finalized.

The test module used to test the ringbuffer is available
here [4].

The series is based on the printk-rework branch of the printk git
e60768311af8 ("scripts/gdb: update for lockless printk ringbuffer")

The list of changes since v3:


- move enum desc_state definition to printk_ringbuffer.h

- change enum desc_state to define the exact state values used
in the state variable

- add DESC_STATE() macro to retrieve the state from the state

- add DESC_SV() macro to build a state variable value given an
ID and state

- get_desc_state(): simply return the state value rather than
processing state flags

- desc_finalized is now a queried state instead of a state flag

- desc_read(): always return a set @state_var, even if the
descriptor is in an inconsistent state (desc_reopen_last()
relies on this)

- change state logic that tested for desc_committed to now test
for desc_finalized, since this is the new state directly
preceding desc_reusable

- data_realloc(): add a check if the data block should shrink
(and in that case, do not modify the data block, i.e. data
blocks will never shrink)

- prb_reserve_in_last(): add WARN_ON for unexpected @text_len

- prb_reserve(): save a copy of @seq and use use memset() to
clear @info

- desc_read_committed_seq(): rename function to
desc_read_finalized_seq() since desc_finalized is the desired
state for readers

- documentation: update state and finalization descriptions


- use @text_len and @dict_len for memcpy() size

gdb scripts

- update to use new state representation

John Ogness

[0] https://lkml.kernel.org/r/20200831011058.6286-1-john.ogness@xxxxxxxxxxxxx
[1] https://lkml.kernel.org/r/20200812163908.GH12903@alley
[2] https://lkml.kernel.org/r/87k1acz5rx.fsf@xxxxxxxxxxxxx
[3] https://lkml.kernel.org/r/20200811160551.GC12903@alley
[4] https://github.com/Linutronix/prb-test.git

John Ogness (6):
printk: ringbuffer: relocate get_data()
printk: ringbuffer: add BLK_DATALESS() macro
printk: ringbuffer: clear initial reserved fields
printk: ringbuffer: change representation of states
printk: ringbuffer: add finalization/extension support
printk: reimplement log_cont using record extension

Documentation/admin-guide/kdump/gdbmacros.txt | 13 +-
kernel/printk/printk.c | 110 +--
kernel/printk/printk_ringbuffer.c | 695 ++++++++++++++----
kernel/printk/printk_ringbuffer.h | 35 +-
scripts/gdb/linux/dmesg.py | 12 +-
5 files changed, 624 insertions(+), 241 deletions(-)