diff mbox

[manpages,1/2] perf_event_open.2: Document PERF_EVENT_IOC_PAUSE_OUTPUT

Message ID 1459160147-240738-1-git-send-email-wangnan0@huawei.com
State New
Headers show

Commit Message

Wang Nan March 28, 2016, 10:15 a.m. UTC
Signed-off-by: Wang Nan <wangnan0@huawei.com>

---
 man2/perf_event_open.2 | 11 +++++++++++
 1 file changed, 11 insertions(+)

-- 
1.8.3.4

Comments

Michael Kerrisk (man-pages) Oct. 21, 2016, 8:56 a.m. UTC | #1
Thanks for this patch, Wangnan.

Vince, do you have any comments?

Cheers,

Michael


On 03/28/2016 12:15 PM, Wang Nan wrote:
> Signed-off-by: Wang Nan <wangnan0@huawei.com>

> ---

>  man2/perf_event_open.2 | 11 +++++++++++

>  1 file changed, 11 insertions(+)

> 

> diff --git a/man2/perf_event_open.2 b/man2/perf_event_open.2

> index c90fc51..b232cba 100644

> --- a/man2/perf_event_open.2

> +++ b/man2/perf_event_open.2

> @@ -2719,6 +2719,17 @@ The argument is a BPF program file descriptor that was created by

>  a previous

>  .BR bpf (2)

>  system call.

> +.TP

> +.BR PERF_EVENT_IOC_PAUSE_OUTPUT " (since Linux 4.6)"

> +.\" commit ? (http://lkml.kernel.org/g/1459147292-239310-2-git-send-email-wangnan0@huawei.com)

> +This allows pausing and resuming the event's ring-buffer. A

> +paused ring-buffer does not prevent samples generation, but simply

> +discards them. The discarded samples are considered lost, causes

> +.BR PERF_RECORD_LOST

> +to be generated when possible.

> +

> +The argument is an integer. Nonzero value pauses the ring-buffer,

> +zero value resumes the ring-buffer.

>  .SS Using prctl

>  A process can enable or disable all the event groups that are

>  attached to it using the

> 



-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
Vince Weaver Oct. 21, 2016, 2:37 p.m. UTC | #2
On Fri, 21 Oct 2016, Michael Kerrisk (man-pages) wrote:

> Thanks for this patch, Wangnan.

> 

> Vince, do you have any comments?

> 


I was catching up chronologically and was still at 4.4, and this was 
still in my queue as a 4.6 change.  I think I thought the patches looked 
good at the time, but I'll revisit them (and write some sample code to 
test out the interface) and get back to you soon.

Vince
Michael Kerrisk (man-pages) Oct. 21, 2016, 2:49 p.m. UTC | #3
Hi Vince,

On 21 October 2016 at 16:37, Vince Weaver <vincent.weaver@maine.edu> wrote:
> On Fri, 21 Oct 2016, Michael Kerrisk (man-pages) wrote:

>

>> Thanks for this patch, Wangnan.

>>

>> Vince, do you have any comments?

>>

>

> I was catching up chronologically and was still at 4.4, and this was

> still in my queue as a 4.6 change.  I think I thought the patches looked

> good at the time, but I'll revisit them (and write some sample code to

> test out the interface) and get back to you soon.


Note that Wang Nan sent out new patches today -- not sure if there
were any changes though.

Cheers,

Michael


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
diff mbox

Patch

diff --git a/man2/perf_event_open.2 b/man2/perf_event_open.2
index c90fc51..b232cba 100644
--- a/man2/perf_event_open.2
+++ b/man2/perf_event_open.2
@@ -2719,6 +2719,17 @@  The argument is a BPF program file descriptor that was created by
 a previous
 .BR bpf (2)
 system call.
+.TP
+.BR PERF_EVENT_IOC_PAUSE_OUTPUT " (since Linux 4.6)"
+.\" commit ? (http://lkml.kernel.org/g/1459147292-239310-2-git-send-email-wangnan0@huawei.com)
+This allows pausing and resuming the event's ring-buffer. A
+paused ring-buffer does not prevent samples generation, but simply
+discards them. The discarded samples are considered lost, causes
+.BR PERF_RECORD_LOST
+to be generated when possible.
+
+The argument is an integer. Nonzero value pauses the ring-buffer,
+zero value resumes the ring-buffer.
 .SS Using prctl
 A process can enable or disable all the event groups that are
 attached to it using the