From nobody Wed Feb 11 05:41:02 2026 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 41E9519D89E for ; Mon, 9 Feb 2026 02:20:06 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1770603606; cv=none; b=TJb5QJVnShIarN+9KH7/GCvcs/zbsIzkyucrd3TZR4Gr5Su3WIxapWL/OoqcZzL5jctMFsKOUxY5n4J4fNIlIuchs8gS5+BXEAcJn8xI5WvzSKsT1y4Hl5iSAGTKxsJWWZtRIxXFSEK5u/tieLsb4y49ZI+W8VWtMHY+OasHod0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1770603606; c=relaxed/simple; bh=PZDLQ4C/EmmsD13YnFkR+qcWRk8KIkgZhUjFW3ZYJ2o=; h=Message-ID:Date:From:To:Cc:Subject:References:MIME-Version: Content-Type; b=Az29FkbjaPQNfBWIJ6PDi+tcW2XSGdbPLGQQ9bMuxHAvvlL0vxzm7jEm9w3GjiPFTxt6HTQDWMBREk+KZXk7Xb262GLizuRFxdz8XnVBqKBVUaXIPwZ3cL7mnMOQvk8Sb6wEGDDFHEcQIckFGWR9BAXCGEYfMWO8Ld0PBQhKYmc= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=fWqwrXJZ; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="fWqwrXJZ" Received: by smtp.kernel.org (Postfix) with ESMTPSA id CC1EAC4CEF7; Mon, 9 Feb 2026 02:20:05 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1770603605; bh=PZDLQ4C/EmmsD13YnFkR+qcWRk8KIkgZhUjFW3ZYJ2o=; h=Date:From:To:Cc:Subject:References:From; b=fWqwrXJZxK+UnNNm1iu4Ai+Z1vjr4WKSRy8Bb4FPo9kknEvUKX3vJvWBJj2WMzo6K OTMLhagu7L/8E65x/rpODPRd2UZ6HkfWRf9W2T4RyEOft8gT+FVC5HuObO8gNGgfDf sFhGnwbX57ExJTCfxfkMXAgB0xtsiUYTvW3STHLvHvDPHouMR2wSNy9JNdyQXg1Fzd TPQiZB+OqKX2P09gU4Xz4C+122Qj3JsWbalugaprEu2mM2cS/7du7pjiXYMJdtV3mt ghys3ItiP65xwWMb4W/tTuiY4cT5vDjG2bKaC45ufQJjG85tAGURRhJyRaFuzc1pIe tzZcAK3JFnqkA== Received: from rostedt by gandalf with local (Exim 4.99.1) (envelope-from ) id 1vpGtQ-0000000Aa0Q-1RNl; Sun, 08 Feb 2026 21:20:52 -0500 Message-ID: <20260209022052.199521041@kernel.org> User-Agent: quilt/0.68 Date: Sun, 08 Feb 2026 21:20:27 -0500 From: Steven Rostedt To: linux-kernel@vger.kernel.org Cc: Masami Hiramatsu , Mark Rutland , Mathieu Desnoyers , Andrew Morton Subject: [for-next][PATCH 01/20] tracing: Add kerneldoc to trace_event_buffer_reserve() References: <20260209022026.627895421@kernel.org> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" From: Steven Rostedt Add a appropriate kerneldoc to trace_event_buffer_reserve() to make it easier to understand how that function is used. Cc: Masami Hiramatsu Cc: Mathieu Desnoyers Link: https://patch.msgid.link/20260130103745.1126e4af@gandalf.local.home Signed-off-by: Steven Rostedt (Google) --- kernel/trace/trace_events.c | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/kernel/trace/trace_events.c b/kernel/trace/trace_events.c index 4972e1a2b5f3..af6d1fe5cab7 100644 --- a/kernel/trace/trace_events.c +++ b/kernel/trace/trace_events.c @@ -649,6 +649,22 @@ bool trace_event_ignore_this_pid(struct trace_event_fi= le *trace_file) } EXPORT_SYMBOL_GPL(trace_event_ignore_this_pid); =20 +/** + * trace_event_buffer_reserve - reserve space on the ring buffer for an ev= ent + * @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) --=20 2.51.0