From: Jiri Olsa <jolsa@kernel.org>
To: Arnaldo Carvalho de Melo <acme@kernel.org>
Cc: lkml <linux-kernel@vger.kernel.org>,
Ingo Molnar <mingo@kernel.org>,
Namhyung Kim <namhyung@kernel.org>,
Alexander Shishkin <alexander.shishkin@linux.intel.com>,
Peter Zijlstra <a.p.zijlstra@chello.nl>,
Adrian Hunter <adrian.hunter@intel.com>,
Andi Kleen <ak@linux.intel.com>,
Stephane Eranian <eranian@google.com>,
Alexey Budankov <alexey.budankov@linux.intel.com>
Subject: [PATCH 17/17] perf record: Describe perf.data directory format
Date: Thu, 21 Feb 2019 10:41:45 +0100 [thread overview]
Message-ID: <20190221094145.9151-18-jolsa@kernel.org> (raw)
In-Reply-To: <20190221094145.9151-1-jolsa@kernel.org>
Adding perf.data-directory-format.txt to describe the
directory data layout.
Link: http://lkml.kernel.org/n/tip-1c8u1thx63v2ldwfdas4xc5d@git.kernel.org
Signed-off-by: Jiri Olsa <jolsa@kernel.org>
---
.../perf.data-directory-format.txt | 54 +++++++++++++++++++
1 file changed, 54 insertions(+)
create mode 100644 tools/perf/Documentation/perf.data-directory-format.txt
diff --git a/tools/perf/Documentation/perf.data-directory-format.txt b/tools/perf/Documentation/perf.data-directory-format.txt
new file mode 100644
index 000000000000..bbd6d31b10c8
--- /dev/null
+++ b/tools/perf/Documentation/perf.data-directory-format.txt
@@ -0,0 +1,54 @@
+perf.data directory format
+
+DISCLAIMER This is not ABI yet and is subject to possible change
+ in following versions of perf. We will remove this
+ disclaimer once the directory format soaks in.
+
+
+This document describes the on-disk perf.data format, generated
+by perf record with --dir option and consumed by the other perf
+tools.
+
+The directory perf.data is created by perf record command by
+using the --dir option:
+
+ $ perf record --dir perf bench sched messaging
+ $ ls -l perf.data
+ total 344
+ -rw-------. 1 jolsa jolsa 43864 Jan 20 22:26 data.0
+ -rw-------. 1 jolsa jolsa 30464 Jan 20 22:26 data.1
+ -rw-------. 1 jolsa jolsa 53816 Jan 20 22:26 data.2
+ -rw-------. 1 jolsa jolsa 30368 Jan 20 22:26 data.3
+ -rw-------. 1 jolsa jolsa 40088 Jan 20 22:26 data.4
+ -rw-------. 1 jolsa jolsa 42592 Jan 20 22:26 data.5
+ -rw-------. 1 jolsa jolsa 56136 Jan 20 22:26 data.6
+ -rw-------. 1 jolsa jolsa 25992 Jan 20 22:26 data.7
+ -rw-------. 1 jolsa jolsa 8832 Jan 20 22:26 header
+
+The header file keeps the standard perf.data file header,
+and the data.* files keep data.
+
+header file
+-----------
+The header file following the standard format describe in
+Documentation/perf.data-file-format doc. Including its data
+portion that is used to store manually synthesized events.
+
+data file
+---------
+The data files layout is described by HEADER_DIR_FORMAT feature.
+Currently it holds only version number (1):
+
+ HEADER_DIR_FORMAT = 24
+
+ struct {
+ uint64_t version;
+ }
+
+The current only only version value 1 means that data files:
+ - follow the 'data.*' format
+ - contain raw events data in standard perf format as read
+ from kernel (and need to be sorted)
+
+Future versions are expected to describe different data files
+layout according to special needs.
--
2.17.2
prev parent reply other threads:[~2019-02-21 9:42 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-21 9:41 [PATCHv2 00/17] perf record: Add support to store data in directory Jiri Olsa
2019-02-21 9:41 ` [PATCH 01/17] perf data: Move size to struct perf_data_file Jiri Olsa
2019-02-28 7:58 ` [tip:perf/core] " tip-bot for Jiri Olsa
2019-02-21 9:41 ` [PATCH 02/17] perf data: Add global path holder Jiri Olsa
2019-02-22 16:05 ` Arnaldo Carvalho de Melo
2019-02-22 16:07 ` Arnaldo Carvalho de Melo
2019-02-28 7:59 ` [tip:perf/core] " tip-bot for Jiri Olsa
2019-02-21 9:41 ` [PATCH 03/17] perf data: Make check_backup work over directories Jiri Olsa
2019-02-21 9:41 ` [PATCH 04/17] perf data: Fail check_backup in case of error Jiri Olsa
2019-02-21 22:23 ` Andi Kleen
2019-02-22 12:23 ` Jiri Olsa
2019-02-21 9:41 ` [PATCH 05/17] perf data: Add perf_data__(create_dir|close_dir) functions Jiri Olsa
2019-02-23 5:07 ` Namhyung Kim
2019-02-24 13:32 ` Jiri Olsa
2019-02-21 9:41 ` [PATCH 06/17] perf data: Add perf_data__open_dir_data function Jiri Olsa
2019-02-21 9:41 ` [PATCH 07/17] perf data: Add directory support Jiri Olsa
2019-02-21 9:41 ` [PATCH 08/17] perf data: Don't store auxtrace index for directory data file Jiri Olsa
2019-02-21 9:41 ` [PATCH 09/17] perf data: Add perf_data__update_dir function Jiri Olsa
2019-02-21 9:41 ` [PATCH 10/17] perf data: Make perf_data__size to work over directory Jiri Olsa
2019-02-21 9:41 ` [PATCH 11/17] perf header: Add DIR_FORMAT feature to describe directory data Jiri Olsa
2019-02-21 9:41 ` [PATCH 12/17] perf session: Add process callback to reader object Jiri Olsa
2019-02-21 9:41 ` [PATCH 13/17] perf session: Add __perf_session__process_dir_events function Jiri Olsa
2019-02-21 9:41 ` [PATCH 14/17] perf session: Add path to reader object Jiri Olsa
2019-02-21 9:41 ` [PATCH 15/17] perf record: Add --dir option to store data in directory Jiri Olsa
2019-02-21 9:41 ` [PATCH 16/17] perf record: Add --output-dir " Jiri Olsa
2019-02-21 9:41 ` Jiri Olsa [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190221094145.9151-18-jolsa@kernel.org \
--to=jolsa@kernel.org \
--cc=a.p.zijlstra@chello.nl \
--cc=acme@kernel.org \
--cc=adrian.hunter@intel.com \
--cc=ak@linux.intel.com \
--cc=alexander.shishkin@linux.intel.com \
--cc=alexey.budankov@linux.intel.com \
--cc=eranian@google.com \
--cc=linux-kernel@vger.kernel.org \
--cc=mingo@kernel.org \
--cc=namhyung@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox