Re: [PATCH] perf_event_open.2: Update description for mmap_data bit

Re: [PATCH] perf_event_open.2: Update description for mmap_data bit

[Vince Weaver]

Here's an updated version of the patch that expands the "mmap" definition 
as well as that of "mmap_data".  Also some manpage related formatting
improvements from the original patch.

I'm not really sure how signed-off-by's and other tags work when modifying 
a patch like this so sorry if I mixed that up.

Signed-off-by: Vince Weaver <vincent.weaver-e7X0jjDqjFGHXe+LvDLADg@public.gmane.org>
Cc: David Ahern <dsahern-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
Cc: Arnaldo Carvalho de Melo <acme-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
Link: https://lkml.org/lkml/2013/11/11/505

---

diff --git a/man2/perf_event_open.2 b/man2/perf_event_open.2
index 1889689..5ba1a42 100644
--- a/man2/perf_event_open.2
+++ b/man2/perf_event_open.2
@@ -805,7 +805,16 @@ If set, don't count when the CPU is idle.
 .IR "mmap"
 The
 .I mmap
-bit enables recording of exec mmap events.
+bit enables generation of
+.I PERF_RECORD_MMAP
+samples for every
+.BR mmap (2)
+call that has
+.I PROT_EXEC
+set.
+This allows tools to notice new executable code being mapped into
+a program (dynamic shared libraries for example)
+so that addresses can be mapped back to the original code.
 .TP
 .IR "comm"
 The
@@ -884,8 +893,14 @@ See also
 .IR "mmap_data" " (Since Linux 2.6.36)"
 The counterpart of the
 .I mmap
-field, but enables including data mmap events
-in the ring-buffer.
+field.
+This enables generation of
+.I PERF_RECORD_MMAP
+samples for
+.BR mmap (2)
+calls that do not have
+.I PROT_EXEC
+set (for example data and SysV shared memory).
 .TP
 .IR "sample_id_all" " (Since Linux 2.6.38)"
 If set, then TID, TIME, ID, STREAM_ID, and CPU can
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] perf_event_open.2: Update description for mmap_data bit

[David Ahern]

On 11/13/13, 10:59 AM, Vince Weaver wrote:
>
> Here's an updated version of the patch that expands the "mmap" definition
> as well as that of "mmap_data".  Also some manpage related formatting
> improvements from the original patch.
>
> I'm not really sure how signed-off-by's and other tags work when modifying
> a patch like this so sorry if I mixed that up.
>

I just want the documentation updated as we find holes. I'm fine with 
your change.

David

--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] perf_event_open.2: Update description for mmap_data bit

[Michael Kerrisk (man-pages)]

On 11/14/13 06:59, Vince Weaver wrote:
> 
> Here's an updated version of the patch that expands the "mmap" definition 
> as well as that of "mmap_data".  Also some manpage related formatting
> improvements from the original patch.
> 
> I'm not really sure how signed-off-by's and other tags work when modifying 
> a patch like this so sorry if I mixed that up.
> 
> Signed-off-by: Vince Weaver <vincent.weaver-e7X0jjDqjFGHXe+LvDLADg@public.gmane.org>
> Cc: David Ahern <dsahern-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
> Cc: Arnaldo Carvalho de Melo <acme-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
> Link: https://lkml.org/lkml/2013/11/11/505

Thanks Vince (and David). I've applied, and added an "Acked-by:" from David, 
since he said he was fine with your revision.

Cheers,

Michael


> ---
> 
> diff --git a/man2/perf_event_open.2 b/man2/perf_event_open.2
> index 1889689..5ba1a42 100644
> --- a/man2/perf_event_open.2
> +++ b/man2/perf_event_open.2
> @@ -805,7 +805,16 @@ If set, don't count when the CPU is idle.
>  .IR "mmap"
>  The
>  .I mmap
> -bit enables recording of exec mmap events.
> +bit enables generation of
> +.I PERF_RECORD_MMAP
> +samples for every
> +.BR mmap (2)
> +call that has
> +.I PROT_EXEC
> +set.
> +This allows tools to notice new executable code being mapped into
> +a program (dynamic shared libraries for example)
> +so that addresses can be mapped back to the original code.
>  .TP
>  .IR "comm"
>  The
> @@ -884,8 +893,14 @@ See also
>  .IR "mmap_data" " (Since Linux 2.6.36)"
>  The counterpart of the
>  .I mmap
> -field, but enables including data mmap events
> -in the ring-buffer.
> +field.
> +This enables generation of
> +.I PERF_RECORD_MMAP
> +samples for
> +.BR mmap (2)
> +calls that do not have
> +.I PROT_EXEC
> +set (for example data and SysV shared memory).
>  .TP
>  .IR "sample_id_all" " (Since Linux 2.6.38)"
>  If set, then TID, TIME, ID, STREAM_ID, and CPU can
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html