diff options
| author | Leo Yan <leo.yan@linaro.org> | 2024-01-02 16:50:01 +0800 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2024-01-30 13:49:02 -0700 |
| commit | 413971526a90f4639d84a027f7cd65a87958cb3b (patch) | |
| tree | b460366646cfa7e30fb50d82338173b9cd22bc8a /Documentation/userspace-api/index.rst | |
| parent | 8722435d325b642d2969f32ec0daacf0dbaae276 (diff) | |
| download | linux-413971526a90f4639d84a027f7cd65a87958cb3b.tar.gz linux-413971526a90f4639d84a027f7cd65a87958cb3b.tar.bz2 linux-413971526a90f4639d84a027f7cd65a87958cb3b.zip | |
Documentation: userspace-api: Document perf ring buffer mechanism
In the Linux perf tool, the ring buffer serves not only as a medium for
transferring PMU event data but also as a vital mechanism for hardware
tracing using technologies like Intel PT and Arm CoreSight, etc.
Consequently, the ring buffer mechanism plays a crucial role by ensuring
high throughput for data transfer between the kernel and user space
while avoiding excessive overhead caused by the ring buffer itself.
This commit documents the ring buffer mechanism in detail. It explains
the implementation of both the regular ring buffer and the AUX ring
buffer. Additionally, it covers how these ring buffers support various
tracing modes and explains the synchronization with memory barriers.
Signed-off-by: Leo Yan <leo.yan@linaro.org>
Reviewed-by: James Clark <james.clark@arm.com>
Reviewed-by: Namhyung Kim <namhyung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240102085001.228815-1-leo.yan@linaro.org
Diffstat (limited to 'Documentation/userspace-api/index.rst')
| -rw-r--r-- | Documentation/userspace-api/index.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/Documentation/userspace-api/index.rst b/Documentation/userspace-api/index.rst index 99a388fdefb5..67d663cf2ff2 100644 --- a/Documentation/userspace-api/index.rst +++ b/Documentation/userspace-api/index.rst @@ -58,6 +58,9 @@ Everything else ELF netlink/index sysfs-platform_profile + vduse + futex2 + perf_ring_buffer .. only:: subproject and html |