perf_event_open.2: E2BIG documentation

The following documents the E2BIG error return for
perf_event_open().

I actually ran into this error the hard way and it took me
half a day to figure out why my ->size value was changing.

Signed-off-by: Vince Weaver <vincent.weaver@maine.edu>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Vince Weaver 2013-10-10 17:20:25 -04:00 committed by Michael Kerrisk
parent b5dedda7d3
commit 82b09254af
1 changed files with 15 additions and 0 deletions

View File

@ -2121,6 +2121,21 @@ returns the new file descriptor, or \-1 if an error occurred
is set appropriately).
.SH ERRORS
.TP
.B E2BIG
Returned if the perf_event_attr
.I size
value is too small
(smaller than
.BR PERF_ATTR_SIZE_VER0 ),
too big (larger than the page size),
or larger than the kernel supports and the extra bytes are not zero.
When
.B E2BIG
is returned, the perf_event_attr
.I size
field is over-written by the kernel to be the size of the structure
it was expecting.
.TP
.B EINVAL
Returned if the specified event is not available.
.TP