From nobody Sat Apr 11 13:57:28 2026 Received: from mail-wm1-f73.google.com (mail-wm1-f73.google.com [209.85.128.73]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 7CA4E3BD646 for ; Fri, 6 Mar 2026 14:36:10 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.73 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1772807772; cv=none; b=HBXYOKPfqRGsXdzKFq+m25iJLQH87L04J+FoQB23ygRKXXsS9zQHWxvlIhrHlal3ANpkFnmSBHL3CwdG/KBkcn1oMqtP+Wcd34FNbrKj+tNYTPuwUVXjoDMdGo6ln2C537fualQ3HE8nQeEIpTGoJAUmnRDnG48f3vEPfKLn8U0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1772807772; c=relaxed/simple; bh=7bMiRK0ShivdAJEqAqq8p+bSixyyMffBJzLzrorCG00=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=T/Zj8TzI4j0jwUbrpYDgOWF4X168vDuHXca02XSbK8NR6d4gCixLdDaRWXJ/h3ewi3bYYCghbgsx5LOfwK6LTfWSSmWeM5OVa93KDH/dpkDr7KwMmxP4SextBsQLtH6LPvbMOjSvmViydh6fsJdfEzZuRtJj0kPZm7lmdjvbo6o= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--vdonnefort.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=hTHWL3n5; arc=none smtp.client-ip=209.85.128.73 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--vdonnefort.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="hTHWL3n5" Received: by mail-wm1-f73.google.com with SMTP id 5b1f17b1804b1-4837bfcfe0dso114699485e9.1 for ; Fri, 06 Mar 2026 06:36:10 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1772807769; x=1773412569; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=B6OW0CQFlfUo8gIs8zWJuy/R7hSbmdzTUEKNvWrAy54=; b=hTHWL3n5dqWaLK6E4Y0RAg2V2tS1MgAaNLnhGzERTe76vsBQGn8yx+6ZkMDi7e5so0 aKtZSw7tK3zJ5uHYEFePTKZ5pdlB/yODX7otGJItggYU71+Ej6UCE8ROuYhGYAm1Uaqd 34zwLwAVrLAoFIFIu7WmnRWIhOs9NCy5I/KZ3vQq13ZaPFQMoW28SsGBV0QTzyCQertN NEHuee4sUGJCPGAwz4grGKVr1AXfmsMpTytHXuAPnnBKopF/PLmwmFNaafIIDPYgAJKp kZxecYgiO0wGOvc2Wpih18EDsGnXAYCkByQTE3JDFcR6f1JYRSdYA/gzCpqBAfNWArCW KeMA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1772807769; x=1773412569; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=B6OW0CQFlfUo8gIs8zWJuy/R7hSbmdzTUEKNvWrAy54=; b=O9HWJfvQ2FvxjbmmXfi08DphwgRLQs9NyV6jrN0cJXbqKRoYEOhUPko0cEgoB3mh8O fCTWfxgVA0d/NXBcw1aKTqqpQDjcqgzhjv6ubrE24/PtRrhcMMcJ6x6ULtM8VHlxoqTv 7e8DO5tQxIbjgDCidPIFpMaYbPXsZc22BIPsR/hBBmYhLCIIrg5ffgdLAs4eo32sV3+D ZK4kTV8wvE/fU9UOK82IC08taM9CEpHgoZ0IGM11dgl66rccCSXR3g7Iahb60hRQa4HE RRgwTAXLEUHe9gTMM6q8nszoZxCNSBZ7kY29N04clwF2Zf9uxXObYzcDS4qYap0WcEE0 nAuA== X-Forwarded-Encrypted: i=1; AJvYcCUp2Rt/7R0C2G+fuNV4aGMv4w62Wu0Cvn9pjCbCbAIKe8tbJKnh+ps9fHNkg64DcmnmmR2icgh6SVUiMCw=@vger.kernel.org X-Gm-Message-State: AOJu0YykO4LEoONafglfVkYLSIuGQaHVFLMwguuIAztEbe+NTXuxB0u3 Y4qQ4QmM8ul491+nGa2Ouk0JLwBmJ8gspX6PgIOh9vsTdLzBaDIyoEREXHFg0uIDU2v9bXEGCxe 7I3kON9oPzj1+otVS4jJF+g== X-Received: from wmlu14.prod.google.com ([2002:a05:600c:210e:b0:480:6c6f:8c06]) (user=vdonnefort job=prod-delivery.src-stubby-dispatcher) by 2002:a05:600c:4451:b0:483:bcff:7948 with SMTP id 5b1f17b1804b1-4852692427cmr37315825e9.10.1772807768794; Fri, 06 Mar 2026 06:36:08 -0800 (PST) Date: Fri, 6 Mar 2026 14:35:20 +0000 In-Reply-To: <20260306143536.339777-1-vdonnefort@google.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20260306143536.339777-1-vdonnefort@google.com> X-Mailer: git-send-email 2.53.0.473.g4a7958ca14-goog Message-ID: <20260306143536.339777-17-vdonnefort@google.com> Subject: [PATCH v13 16/32] Documentation: tracing: Add tracing remotes From: Vincent Donnefort To: rostedt@goodmis.org, mhiramat@kernel.org, mathieu.desnoyers@efficios.com, linux-trace-kernel@vger.kernel.org, maz@kernel.org, oliver.upton@linux.dev, joey.gouly@arm.com, suzuki.poulose@arm.com, yuzenghui@huawei.com Cc: kvmarm@lists.linux.dev, linux-arm-kernel@lists.infradead.org, jstultz@google.com, qperret@google.com, will@kernel.org, aneesh.kumar@kernel.org, kernel-team@android.com, linux-kernel@vger.kernel.org, Vincent Donnefort Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Add documentation about the newly introduced tracing remotes framework. Reviewed-by: Steven Rostedt (Google) Signed-off-by: Vincent Donnefort diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst index 338bc4d7cfab..036db96864d2 100644 --- a/Documentation/trace/index.rst +++ b/Documentation/trace/index.rst @@ -91,6 +91,17 @@ interactions. user_events uprobetracer =20 +Remote Tracing +-------------- + +This section covers the framework to read compatible ring-buffers, written= by +entities outside of the kernel (most likely firmware or hypervisor) + +.. toctree:: + :maxdepth: 1 + + remotes + Additional Resources -------------------- =20 diff --git a/Documentation/trace/remotes.rst b/Documentation/trace/remotes.= rst new file mode 100644 index 000000000000..1f9d764f69aa --- /dev/null +++ b/Documentation/trace/remotes.rst @@ -0,0 +1,66 @@ +.. SPDX-License-Identifier: GPL-2.0 + +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Tracing Remotes +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +:Author: Vincent Donnefort + +Overview +=3D=3D=3D=3D=3D=3D=3D=3D +Firmware and hypervisors are black boxes to the kernel. Having a way to se= e what +they are doing can be useful to debug both. This is where remote tracing b= uffers +come in. A remote tracing buffer is a ring buffer executed by the firmware= or +hypervisor into memory that is memory mapped to the host kernel. This is s= imilar +to how user space memory maps the kernel ring buffer but in this case the = kernel +is acting like user space and the firmware or hypervisor is the "kernel" s= ide. +With a trace remote ring buffer, the firmware and hypervisor can record ev= ents +for which the host kernel can see and expose to user space. + +Register a remote +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +A remote must provide a set of callbacks `struct trace_remote_callbacks` w= hom +description can be found below. Those callbacks allows Tracefs to enable a= nd +disable tracing and events, to load and unload a tracing buffer (a set of +ring-buffers) and to swap a reader page with the head page, which enables +consuming reading. + +.. kernel-doc:: include/linux/trace_remote.h + +Once registered, an instance will appear for this remote in the Tracefs +directory **remotes/**. Buffers can then be read using the usual Tracefs f= iles +**trace_pipe** and **trace**. + +Declare a remote event +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Macros are provided to ease the declaration of remote events, in a similar +fashion to in-kernel events. A declaration must provide an ID, a descripti= on of +the event arguments and how to print the event: + +.. code-block:: c + + REMOTE_EVENT(foo, EVENT_FOO_ID, + RE_STRUCT( + re_field(u64, bar) + ), + RE_PRINTK("bar=3D%lld", __entry->bar) + ); + +Then those events must be declared in a C file with the following: + +.. code-block:: c + + #define REMOTE_EVENT_INCLUDE_FILE foo_events.h + #include + +This will provide a `struct remote_event remote_event_foo` that can be giv= en to +`trace_remote_register`. + +Registered events appear in the remote directory under **events/**. + +Simple ring-buffer +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +A simple implementation for a ring-buffer writer can be found in +kernel/trace/simple_ring_buffer.c. + +.. kernel-doc:: include/linux/simple_ring_buffer.h --=20 2.53.0.473.g4a7958ca14-goog