This manpage patch relates to the addition of the AUX sample type
as added in the following commit:
commit 68db7e98c3a6ebe7284b6cf14906ed7c55f3f7f0
Author: Alexander Shishkin <[email protected]>
perf: Add AUX record
Signed-off-by: Alexander Shishkin <[email protected]>
Signed-off-by: Peter Zijlstra (Intel) <[email protected]>
Cc: Arnaldo Carvalho de Melo <[email protected]>
Cc: Borislav Petkov <[email protected]>
Cc: Frederic Weisbecker <[email protected]>
Cc: H. Peter Anvin <[email protected]>
Cc: Kaixu Xia <[email protected]>
Cc: Linus Torvalds <[email protected]>
Cc: Mike Galbraith <[email protected]>
Cc: Paul Mackerras <[email protected]>
Cc: Robert Richter <[email protected]>
Cc: Stephane Eranian <[email protected]>
Cc: Thomas Gleixner <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Link: http://lkml.kernel.org/r/1421237903-181015-7-git-send-email-alexander.shishkin@linux.intel.com
Signed-off-by: Ingo Molnar <[email protected]>
Signed-off-by: Vince Weaver <[email protected]>
diff --git a/man2/perf_event_open.2 b/man2/perf_event_open.2
index 01ee579..98aef57 100644
--- a/man2/perf_event_open.2
+++ b/man2/perf_event_open.2
@@ -2310,6 +2310,39 @@ is the flags information.
.I filename
is a string describing the backing of the allocated memory.
.RE
+.TP
+.BR PERF_RECORD_AUX " (since Linux 4.1)"
+\" commit 68db7e98c3a6ebe7284b6cf14906ed7c55f3f7f0
+This record reports that new data is available in the separate
+AUX buffer region.
+
+.in +4n
+.nf
+struct {
+ struct perf_event_header header;
+ u64 aux_offset;
+ u64 aux_size;
+ u64 flags;
+ struct sample_id sample_id;
+};
+.fi
+.RS
+.TP
+.I aux_offset
+offset in the AUX mmap region where the new data begins.
+.TP
+.I aux_size
+size of the data made available.
+.TP
+.I flags
+describes the aux update.
+.RS
+.TP
+.B PERF_AUX_FLAG_TRUNCATED
+if set then the data returned was truncated to fix the available
+buffer size.
+.RE
+.RE
.RE
.SS Overflow handling
Events can be set to notify when a threshold is crossed,