[PATCH v4 12/18] ring-buffer: Add kerneldoc for ring_buffer_poll_remote
Vincent Donnefort <[email protected]> Tue, 4 Aug 2026 15:03:27 +0100
| Newsgroups | org.kernel.vger.linux-trace-kernel,org.kernel.vger.linux-kernel |
|---|---|
| Message-ID | <[email protected]> |
Document ring_buffer_poll_remote(). Signed-off-by: Vincent Donnefort <[email protected]> diff --git a/kernel/trace/ring_buffer.c b/kernel/trace/ring_buffer.c index 4bb1a7780860..8cb10e9da122 100644 --- a/kernel/trace/ring_buffer.c +++ b/kernel/trace/ring_buffer.c @@ -6848,6 +6848,17 @@ int ring_buffer_read_remote_meta_page(struct trace_buffer *buffer, int cpu) return 0; } +/** + * ring_buffer_poll_remote - poll a remote ring buffer for new data + * @buffer: The ring buffer + * @cpu: The CPU buffer to poll (or RING_BUFFER_ALL_CPUS) + * + * This function polls the specified remote CPU buffer (or all of them) + * by reading its meta page to update the local reader's view. If new + * entries are detected, it triggers wakeups for any waiting readers. + * Returns: + * 0 on success, or -EINVAL if the CPU is not in the buffer's cpumask. + */ int ring_buffer_poll_remote(struct trace_buffer *buffer, int cpu) { struct ring_buffer_per_cpu *cpu_buffer; -- 2.55.0.571.g244d577d93-goog