Commit 02b75ece authored by Steven Rostedt's avatar Steven Rostedt Committed by Steven Rostedt (Google)
Browse files

tracing: Add kerneldoc to trace_event_buffer_reserve() 

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: default avatarSteven Rostedt (Google) <rostedt@goodmis.org>
parent a46023d5

kernel/trace/trace_events.c

+16 −0
Original line number Diff line number Diff line
@@ -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)