archives/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-03-14 00:56:20 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

tracing: Add kerneldoc to trace_event_buffer_reserve()

Browse source 
Add a appropriate kerneldoc to trace_event_buffer_reserve() to make it
easier to understand how that function is used.

Cc: Masami Hiramatsu <mhiramat@kernel.org>
Cc: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Link: https://patch.msgid.link/20260130103745.1126e4af@gandalf.local.home
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
This commit is contained in:
Steven Rostedt 2026-01-30 10:37:45 -05:00 • committed by Steven Rostedt (Google)
parent a46023d561
commit 02b75ece53
1 changed files with 16 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
kernel/trace/trace_events.c
View file

@ -649,6 +649,22 @@ bool trace_event_ignore_this_pid(struct trace_event_file *trace_file)
}
EXPORT_SYMBOL_GPL(trace_event_ignore_this_pid);
/**
* trace_event_buffer_reserve - reserve space on the ring buffer for an event
* @fbuffer: information about how to save the event
* @trace_file: the instance file descriptor for the event
* @len: The length of the event
*
* The @fbuffer has information about the ring buffer and data will
* be added to it to be used by the call to trace_event_buffer_commit().
* The @trace_file is the desrciptor with information about the status
* of the given event for a specific trace_array instance.
* The @len is the length of data to save for the event.
*
* Returns a pointer to the data on the ring buffer or NULL if the
* event was not reserved (event was filtered, too big, or the buffer
* simply was disabled for write).
*/
void *trace_event_buffer_reserve(struct trace_event_buffer *fbuffer,
struct trace_event_file *trace_file,
unsigned long len)