perf_event_open.2: Clarify PERF_SAMPLE_STACK_USER usage

This clarifies the PERF_SAMPLE_STACK_USER section.
I found these issue while implementing some code that uses
the option.  The important change is fixing the name of the
sample_stack_user parameter, the rest is just some wording
fixes and minor clarifications.

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 2014-07-13 22:29:19 -04:00 committed by Michael Kerrisk
parent b7800b443e
commit 02ca78a0c7
1 changed files with 5 additions and 3 deletions

View File

@ -1885,13 +1885,15 @@ bit mask.
.IR size ", " data[size] ", " dyn_size
If
.B PERF_SAMPLE_STACK_USER
is enabled, then record the user stack to enable backtracing.
is enabled, then the user stack is recorded.
This can be used to generate stack backtraces.
.I size
is the size requested by the user in
.I stack_user_size
.I sample_stack_user
or else the maximum record size.
.I data
is the stack data.
is the stack data (a raw dump of the memory pointed to by the
stack pointer at the time of sampling).
.I dyn_size
is the amount of data actually dumped (can be less than
.IR size ).