Received: by 2002:a05:7412:3b8b:b0:fc:a2b0:25d7 with SMTP id nd11csp830023rdb; Fri, 9 Feb 2024 02:24:52 -0800 (PST) X-Google-Smtp-Source: AGHT+IGcnAyHjQr3xwFzLvEbaI8rp/iWfGrooWaV25+XhCU8JtL0A6XxnZn604fw9T14MizWN5IX X-Received: by 2002:a17:906:40c:b0:a3b:cc20:31c with SMTP id d12-20020a170906040c00b00a3bcc20031cmr730266eja.41.1707474291923; Fri, 09 Feb 2024 02:24:51 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1707474291; cv=pass; d=google.com; s=arc-20160816; b=ikl1/3E5PgBMUMbgGPV77JLrRr7507Je9zckZP6XHZo2Nfui7gu3GNoNh+ENCQt7/c 48Lf7aj4KvwP0LXMzGtg1roMtDfQqzysLDLz4BgGAwXDwMSSRw09BrqzUpemPW/alnZq nc/A7BbDjOcg/2XhcxT3yXeo3QrBZka8zD4/WPvw7w+OoseoH0iNbjndlj+BDekiFG1H c5b86WnEWlvsPmyRvFlKFJVW0abAtwXw2LGsov5PYov2s8rI8nAonb9tpZnFIe2qmSa7 ImtaLYCtVfalYwpLHeBI7Q7FePel+v0q8QxIWhrz71FSc2gL318NGKAUb1DVySzNKuPc 6U6A== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=cc:to:from:subject:message-id:references:mime-version :list-unsubscribe:list-subscribe:list-id:precedence:in-reply-to:date :dkim-signature; bh=QgkRDZd+PHk3bo7bl2fMfaI4+BE0z0Hk4GDGmCozprQ=; fh=IdPF6Zl2/RB8kH4vBJOWFPRRWSKYh2QADEQ/hSN+DGA=; b=hNYtH9QOVI4XmLLb77NxOXlW9Hjz5faXG3BlTye/7PXZ97ZSBpBdP/58tnlsSBtzqG PmtcZA2D6KKD3wEkcFem7fPheGIpcoKInUKr4VdBjygpNKdir64CoyQj/r4NOtDRwPlh iAClgPoDkM7QyuqAA8hIfEcZmlN+5mHFDlE7BFSkqS4K35j/kcOdJNGn0BEAN4zJsYMb ZBNteQctHlDgaQ85J1A749sllOJdRPV69sjw0MFZ1ncg2h8Ta3+gZlfFSi8meBPucycd wJaEph3tKwdY8sDV8hIKlvrDfVT2EnJ030GGXQVTCiQsRE0JNQ9vRiuS1QZc0Gzbo4oQ NSwQ==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=tBWat87h; arc=pass (i=1 spf=pass spfdomain=flex--vdonnefort.bounces.google.com dkim=pass dkdomain=google.com dmarc=pass fromdomain=google.com); spf=pass (google.com: domain of linux-kernel+bounces-59218-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-59218-linux.lists.archive=gmail.com@vger.kernel.org"; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com X-Forwarded-Encrypted: i=2; AJvYcCWfvrFoGRuTK6Ps80NtWJUc5zVnZnhpKVQOyBYtLP6zV7Lwo50+7RnWDzeiSqx2SxS7QMRrtB98w1k7u1e3J+iGIZQj4X0iGbea2bpRrA== Return-Path: Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [147.75.80.249]) by mx.google.com with ESMTPS id f13-20020a1709067f8d00b00a3820b34ad1si667367ejr.389.2024.02.09.02.24.51 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 09 Feb 2024 02:24:51 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-59218-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=tBWat87h; arc=pass (i=1 spf=pass spfdomain=flex--vdonnefort.bounces.google.com dkim=pass dkdomain=google.com dmarc=pass fromdomain=google.com); spf=pass (google.com: domain of linux-kernel+bounces-59218-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-59218-linux.lists.archive=gmail.com@vger.kernel.org"; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by am.mirrors.kernel.org (Postfix) with ESMTPS id 805B51F21DB5 for ; Fri, 9 Feb 2024 10:24:51 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id CEFAD69D37; Fri, 9 Feb 2024 10:22:27 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="tBWat87h" Received: from mail-yw1-f202.google.com (mail-yw1-f202.google.com [209.85.128.202]) (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 53BF96BB4D for ; Fri, 9 Feb 2024 10:22:24 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.202 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707474146; cv=none; b=KFZiDJUzoR3VaqmymVJv5hFO+8UIDh6rYg7VprcFC7SUF1eiP+tRztrik7Y5voTS85gGLLJkBS1N2S9dewWg3h7leYGroZ+O3j3dn4jSGi8cNz5cBpgHx29aj7ld6NJ1/BCzZeKBM+/knbFWkk2rmanAyColViUKGqFGlPj7sgQ= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707474146; c=relaxed/simple; bh=iPiTM2h7tTVjI8Bap8UHkeVYN1GEEKgHI982louZIPs=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=eMXm0J2xMrGi4F16K/362HW85+p19/eEM9gHjC2t60bBP563dKpzLaQGhRNmC8Owvkm2G1YHRWuYrAP220Ay3dKdHso9VkoLAJADb1PHnbXiG4hm6REt3bnEWscmHDw47HDE/kyJloLvm0alXDb8zbv6oNzy8xNyf+QqXHpkYtM= 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=tBWat87h; arc=none smtp.client-ip=209.85.128.202 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 Received: by mail-yw1-f202.google.com with SMTP id 00721157ae682-6047a047f4cso22451957b3.3 for ; Fri, 09 Feb 2024 02:22:24 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1707474143; x=1708078943; 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=QgkRDZd+PHk3bo7bl2fMfaI4+BE0z0Hk4GDGmCozprQ=; b=tBWat87hkNnH5xslKZXl0zV+dOOXPYB3JLZcZlutDQ2hCgQWBAjt5k6a8IvVL/PNmv 1tF5owEVNy0DVEVUFM9prOp5ZPWC2CYMdydy04bKfdg/rGSJEbnuaE+zXYAL/FkUjdSl C3LSNIFP9I+idO6O8bDG02JunEtfLCTtNKlE7bWS8aFgTMd45RjgWN4TLNHVoQ0j4QI4 fXAp9g75pCI4vgEH+9k6RF+zsPdZ0wEaqD4ZivrcaW9LqAMZvKw6eJUDgJd9Bwl0oQXg 5ii4feaV8B7gZ8VyrGJ2UqsNtJdAhuM9WBAB9KhzPnCPGGH6MlCcXqH2Pr0PX3HvHXZP iFag== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1707474143; x=1708078943; 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=QgkRDZd+PHk3bo7bl2fMfaI4+BE0z0Hk4GDGmCozprQ=; b=CzZ5dKlGiFsCfQOpLKOPRWpQIY6OqO4Al41wO8/bXoQGe2ao5CQXJLyoJFL/aQQk2B mzWCKVQpNcA9Ll7UshhCdYfUyhbUQJVa4IX+g3UKlBrl3RP2m6s7DZInV+Ataj722Lo9 UPSME0HcZTqRZaGf4ySWSM7DBsLf8vpiiKMQOCwoO7qZ3G/AnrHadko9sPNy803U79ts Z+AOQYJ/gfZr1ZvXYwLaaON0U3iy/3FDbO+7md48Y7Bt0LZVBTWEouh2AqLSFdmQpQ8u ZOH9bcOjgNoCq1PoS2a5SO5o210dKnqZvJYcfOBpzZ8hJVR5kX9UxRjzjKTvSS5SMZYl g+aQ== X-Gm-Message-State: AOJu0YyrPA5v3tXunPJAtdYgPS1zqgLKPDcWzmx+bQLNQaf+UylgHv31 BlGczlbuL1JOXOHebzYwVFhy6EDdYbe8sYyYVsI2ykX0MhpA0Jtop3p2/uDiPMTVdiSQ/Z6+95h yaf5aIsMf4cSnMDmX7A== X-Received: from vdonnefort.c.googlers.com ([fda3:e722:ac3:cc00:28:9cb1:c0a8:2eea]) (user=vdonnefort job=sendgmr) by 2002:a05:690c:3687:b0:604:9cad:8c36 with SMTP id fu7-20020a05690c368700b006049cad8c36mr275510ywb.4.1707474143306; Fri, 09 Feb 2024 02:22:23 -0800 (PST) Date: Fri, 9 Feb 2024 10:22:01 +0000 In-Reply-To: <20240209102202.649049-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: <20240209102202.649049-1-vdonnefort@google.com> X-Mailer: git-send-email 2.43.0.687.g38aa6559b0-goog Message-ID: <20240209102202.649049-6-vdonnefort@google.com> Subject: [PATCH v15 5/6] Documentation: tracing: Add ring-buffer mapping From: Vincent Donnefort To: rostedt@goodmis.org, mhiramat@kernel.org, linux-kernel@vger.kernel.org, linux-trace-kernel@vger.kernel.org Cc: mathieu.desnoyers@efficios.com, kernel-team@android.com, Vincent Donnefort Content-Type: text/plain; charset="UTF-8" It is now possible to mmap() a ring-buffer to stream its content. Add some documentation and a code example. Signed-off-by: Vincent Donnefort diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst index 5092d6c13af5..0b300901fd75 100644 --- a/Documentation/trace/index.rst +++ b/Documentation/trace/index.rst @@ -29,6 +29,7 @@ Linux Tracing Technologies timerlat-tracer intel_th ring-buffer-design + ring-buffer-map stm sys-t coresight/index diff --git a/Documentation/trace/ring-buffer-map.rst b/Documentation/trace/ring-buffer-map.rst new file mode 100644 index 000000000000..628254e63830 --- /dev/null +++ b/Documentation/trace/ring-buffer-map.rst @@ -0,0 +1,104 @@ +.. SPDX-License-Identifier: GPL-2.0 + +================================== +Tracefs ring-buffer memory mapping +================================== + +:Author: Vincent Donnefort + +Overview +======== +Tracefs ring-buffer memory map provides an efficient method to stream data +as no memory copy is necessary. The application mapping the ring-buffer becomes +then a consumer for that ring-buffer, in a similar fashion to trace_pipe. + +Memory mapping setup +==================== +The mapping works with a mmap() of the trace_pipe_raw interface. + +The first system page of the mapping contains ring-buffer statistics and +description. It is referred as the meta-page. One of the most important field of +the meta-page is the reader. It contains the sub-buffer ID which can be safely +read by the mapper (see ring-buffer-design.rst). + +The meta-page is followed by all the sub-buffers, ordered by ascendant ID. It is +therefore effortless to know where the reader starts in the mapping: + +.. code-block:: c + + reader_id = meta->reader->id; + reader_offset = meta->meta_page_size + reader_id * meta->subbuf_size; + +When the application is done with the current reader, it can get a new one using +the trace_pipe_raw ioctl() TRACE_MMAP_IOCTL_GET_READER. This ioctl also updates +the meta-page fields. + +Limitations +=========== +When a mapping is in place on a Tracefs ring-buffer, it is not possible to +either resize it (either by increasing the entire size of the ring-buffer or +each subbuf). It is also not possible to use snapshot or splice. + +Concurrent readers (either another application mapping that ring-buffer or the +kernel with trace_pipe) are allowed but not recommended. They will compete for +the ring-buffer and the output is unpredictable. + +Example +======= + +.. code-block:: c + + #include + #include + #include + #include + + #include + + #include + #include + + #define TRACE_PIPE_RAW "/sys/kernel/tracing/per_cpu/cpu0/trace_pipe_raw" + + int main(void) + { + int page_size = getpagesize(), fd, reader_id; + unsigned long meta_len, data_len; + struct trace_buffer_meta *meta; + void *map, *reader, *data; + + fd = open(TRACE_PIPE_RAW, O_RDONLY | O_NONBLOCK); + if (fd < 0) + exit(EXIT_FAILURE); + + map = mmap(NULL, page_size, PROT_READ, MAP_SHARED, fd, 0); + if (map == MAP_FAILED) + exit(EXIT_FAILURE); + + meta = (struct trace_buffer_meta *)map; + meta_len = meta->meta_page_size; + + printf("entries: %llu\n", meta->entries); + printf("overrun: %llu\n", meta->overrun); + printf("read: %llu\n", meta->read); + printf("nr_subbufs: %u\n", meta->nr_subbufs); + + data_len = meta->subbuf_size * meta->nr_subbufs; + data = mmap(NULL, data_len, PROT_READ, MAP_SHARED, fd, meta_len); + if (data == MAP_FAILED) + exit(EXIT_FAILURE); + + if (ioctl(fd, TRACE_MMAP_IOCTL_GET_READER) < 0) + exit(EXIT_FAILURE); + + reader_id = meta->reader.id; + reader = data + meta->subbuf_size * reader_id; + + printf("Current reader address: %p\n", reader); + + munmap(data, data_len); + munmap(meta, meta_len); + close (fd); + + return 0; + } -- 2.43.0.687.g38aa6559b0-goog