Skip to contentSkip to conversation

perf data: Document clockid header: HEADER_CLOCKID

tip:perf/core tip-bot for Arnaldo Carvalho de Melo 1 participant 1 message Jun 17, 2019 perf events

lore
Share & tools
lore
#0 lore raw
Commit-ID:  a9de7cfc7663882e98ec3b2ecf35c546a013b956
Gitweb:     https://git.kernel.org/tip/a9de7cfc7663882e98ec3b2ecf35c546a013b956
Author:     Arnaldo Carvalho de Melo <[email protected]>
AuthorDate: Wed, 29 May 2019 15:43:51 -0300
Committer:  Arnaldo Carvalho de Melo <[email protected]>
CommitDate: Wed, 5 Jun 2019 09:47:53 -0300

perf data: Document clockid header: HEADER_CLOCKID

We forgot to update the perf.data file format document for the HEADER_CLOCKID header, do it now from comments in the patch introducing it.

Cc Adrian Hunter <[email protected]>
Cc Alexander Shishkin <[email protected]>
Cc Alexey Budankov <[email protected]>
Cc Andi Kleen <[email protected]>
Cc Chong Jiang <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Peter Zijlstra <[email protected]>
Cc Simon Que <[email protected]>
Fixes cf7905165fee ("perf record: Encode -k clockid frequency into Perf trace")
---
 tools/perf/Documentation/perf.data-file-format.txt | 6 ++++++
 1 file changed, 6 insertions(+)
tools/perf/Documentation/perf.data-file-format.txt +6 -0
index 99733751695b..600999f89c6d 100644
@@ -296,6 +296,12 @@ $ perf report --header-only -I
 # memory nodes (nr 1, block size 0x8000000):
 #    0 [7G]: 0-23,32-69
 
+	HEADER_CLOCKID = 23,
+
+One uint64_t for the clockid frequency, specified, for instance, via 'perf
+record -k' (see clock_gettime()), to enable timestamps derived metrics
+conversion into wall clock time on the reporting stage.
+
         HEADER_BPF_PROG_INFO = 25,
 
 struct bpf_prog_info_linear, which contains detailed information about