| Message ID | 20240611112158.40795-10-jolsa@kernel.org (mailing list archive) |
|---|---|
| State | Accepted |
| Headers | show |
| Series | uprobe: uretprobe speed up | expand |
On Tue, 11 Jun 2024 13:21:58 +0200 Jiri Olsa <jolsa@kernel.org> wrote: > Adding man page for new uretprobe syscall. > > Acked-by: Andrii Nakryiko <andrii@kernel.org> > Reviewed-by: Alejandro Colomar <alx@kernel.org> > Signed-off-by: Jiri Olsa <jolsa@kernel.org> This looks good to me. Reviewed-by: Masami Hiramatsu (Google) <mhiramat@kernel.org> And this needs to be picked by linux-man@ project. Thank you, > --- > man/man2/uretprobe.2 | 56 ++++++++++++++++++++++++++++++++++++++++++++ > 1 file changed, 56 insertions(+) > create mode 100644 man/man2/uretprobe.2 > > diff --git a/man/man2/uretprobe.2 b/man/man2/uretprobe.2 > new file mode 100644 > index 000000000000..cf1c2b0d852e > --- /dev/null > +++ b/man/man2/uretprobe.2 > @@ -0,0 +1,56 @@ > +.\" Copyright (C) 2024, Jiri Olsa <jolsa@kernel.org> > +.\" > +.\" SPDX-License-Identifier: Linux-man-pages-copyleft > +.\" > +.TH uretprobe 2 (date) "Linux man-pages (unreleased)" > +.SH NAME > +uretprobe \- execute pending return uprobes > +.SH SYNOPSIS > +.nf > +.B int uretprobe(void) > +.fi > +.SH DESCRIPTION > +The > +.BR uretprobe () > +system call is an alternative to breakpoint instructions for triggering return > +uprobe consumers. > +.P > +Calls to > +.BR uretprobe () > +system call are only made from the user-space trampoline provided by the kernel. > +Calls from any other place result in a > +.BR SIGILL . > +.SH RETURN VALUE > +The > +.BR uretprobe () > +system call return value is architecture-specific. > +.SH ERRORS > +.TP > +.B SIGILL > +The > +.BR uretprobe () > +system call was called by a user-space program. > +.SH VERSIONS > +Details of the > +.BR uretprobe () > +system call behavior vary across systems. > +.SH STANDARDS > +None. > +.SH HISTORY > +TBD > +.SH NOTES > +The > +.BR uretprobe () > +system call was initially introduced for the x86_64 architecture > +where it was shown to be faster than breakpoint traps. > +It might be extended to other architectures. > +.P > +The > +.BR uretprobe () > +system call exists only to allow the invocation of return uprobe consumers. > +It should > +.B never > +be called directly. > +Details of the arguments (if any) passed to > +.BR uretprobe () > +and the return value are architecture-specific. > -- > 2.45.1 >
Hi, On Tue, Jun 11, 2024 at 11:30:22PM GMT, Masami Hiramatsu wrote: > On Tue, 11 Jun 2024 13:21:58 +0200 > Jiri Olsa <jolsa@kernel.org> wrote: > > > Adding man page for new uretprobe syscall. > > > > Acked-by: Andrii Nakryiko <andrii@kernel.org> > > Reviewed-by: Alejandro Colomar <alx@kernel.org> > > Signed-off-by: Jiri Olsa <jolsa@kernel.org> > > This looks good to me. > > Reviewed-by: Masami Hiramatsu (Google) <mhiramat@kernel.org> > > And this needs to be picked by linux-man@ project. Yup; please ping me when the rest is merged and I should pick it. Have a lovely day! Alex > > Thank you, > > > --- > > man/man2/uretprobe.2 | 56 ++++++++++++++++++++++++++++++++++++++++++++ > > 1 file changed, 56 insertions(+) > > create mode 100644 man/man2/uretprobe.2 > > > > diff --git a/man/man2/uretprobe.2 b/man/man2/uretprobe.2 > > new file mode 100644 > > index 000000000000..cf1c2b0d852e > > --- /dev/null > > +++ b/man/man2/uretprobe.2 > > @@ -0,0 +1,56 @@ > > +.\" Copyright (C) 2024, Jiri Olsa <jolsa@kernel.org> > > +.\" > > +.\" SPDX-License-Identifier: Linux-man-pages-copyleft > > +.\" > > +.TH uretprobe 2 (date) "Linux man-pages (unreleased)" > > +.SH NAME > > +uretprobe \- execute pending return uprobes > > +.SH SYNOPSIS > > +.nf > > +.B int uretprobe(void) > > +.fi > > +.SH DESCRIPTION > > +The > > +.BR uretprobe () > > +system call is an alternative to breakpoint instructions for triggering return > > +uprobe consumers. > > +.P > > +Calls to > > +.BR uretprobe () > > +system call are only made from the user-space trampoline provided by the kernel. > > +Calls from any other place result in a > > +.BR SIGILL . > > +.SH RETURN VALUE > > +The > > +.BR uretprobe () > > +system call return value is architecture-specific. > > +.SH ERRORS > > +.TP > > +.B SIGILL > > +The > > +.BR uretprobe () > > +system call was called by a user-space program. > > +.SH VERSIONS > > +Details of the > > +.BR uretprobe () > > +system call behavior vary across systems. > > +.SH STANDARDS > > +None. > > +.SH HISTORY > > +TBD > > +.SH NOTES > > +The > > +.BR uretprobe () > > +system call was initially introduced for the x86_64 architecture > > +where it was shown to be faster than breakpoint traps. > > +It might be extended to other architectures. > > +.P > > +The > > +.BR uretprobe () > > +system call exists only to allow the invocation of return uprobe consumers. > > +It should > > +.B never > > +be called directly. > > +Details of the arguments (if any) passed to > > +.BR uretprobe () > > +and the return value are architecture-specific. > > -- > > 2.45.1 > > > > > -- > Masami Hiramatsu (Google) <mhiramat@kernel.org> >
On Tue, 11 Jun 2024 16:49:24 +0200 Alejandro Colomar <alx@kernel.org> wrote: > Hi, > > On Tue, Jun 11, 2024 at 11:30:22PM GMT, Masami Hiramatsu wrote: > > On Tue, 11 Jun 2024 13:21:58 +0200 > > Jiri Olsa <jolsa@kernel.org> wrote: > > > > > Adding man page for new uretprobe syscall. > > > > > > Acked-by: Andrii Nakryiko <andrii@kernel.org> > > > Reviewed-by: Alejandro Colomar <alx@kernel.org> > > > Signed-off-by: Jiri Olsa <jolsa@kernel.org> > > > > This looks good to me. > > > > Reviewed-by: Masami Hiramatsu (Google) <mhiramat@kernel.org> > > > > And this needs to be picked by linux-man@ project. > > Yup; please ping me when the rest is merged and I should pick it. Just in case nobody pinged you, the rest of the series is now in Linus's tree. -- Steve > > Have a lovely day! > Alex >
Hi Steven, Jiri, On Wed, Aug 07, 2024 at 04:27:34PM GMT, Steven Rostedt wrote: > Just in case nobody pinged you, the rest of the series is now in Linus's > tree. Thanks for the ping! I have prepared some tweaks to the patch (see below). Also, I have some doubts. The prototype shows that it has no arguments (void), but the text said that arguments, if any, are arch-specific. Does any arch have arguments? Should we use a variadic prototype (...)? Please add the changes proposed below to your patch, tweak anything if you consider it appropriate) and send it as v10. Have a lovely day! Alex diff --git i/man/man2/uretprobe.2 w/man/man2/uretprobe.2 index cf1c2b0d8..51b566998 100644 --- i/man/man2/uretprobe.2 +++ w/man/man2/uretprobe.2 @@ -7,50 +7,43 @@ .SH NAME uretprobe \- execute pending return uprobes .SH SYNOPSIS .nf -.B int uretprobe(void) +.B int uretprobe(void); .fi .SH DESCRIPTION -The .BR uretprobe () -system call is an alternative to breakpoint instructions for triggering return -uprobe consumers. +is an alternative to breakpoint instructions +for triggering return uprobe consumers. .P Calls to .BR uretprobe () -system call are only made from the user-space trampoline provided by the kernel. +are only made from the user-space trampoline provided by the kernel. Calls from any other place result in a .BR SIGILL . -.SH RETURN VALUE -The +.P +Details of the arguments (if any) passed to .BR uretprobe () -system call return value is architecture-specific. +are architecture-specific. +.SH RETURN VALUE +The return value is architecture-specific. .SH ERRORS .TP .B SIGILL -The .BR uretprobe () -system call was called by a user-space program. +was called by a user-space program. .SH VERSIONS -Details of the -.BR uretprobe () -system call behavior vary across systems. +The behavior varies across systems. .SH STANDARDS None. .SH HISTORY -TBD -.SH NOTES -The +Linux 6.11. +.P .BR uretprobe () -system call was initially introduced for the x86_64 architecture +was initially introduced for the x86_64 architecture where it was shown to be faster than breakpoint traps. It might be extended to other architectures. -.P -The +.SH CAVEATS .BR uretprobe () -system call exists only to allow the invocation of return uprobe consumers. +exists only to allow the invocation of return uprobe consumers. It should .B never be called directly. -Details of the arguments (if any) passed to -.BR uretprobe () -and the return value are architecture-specific.
On Fri, Aug 16, 2024 at 01:42:26PM +0200, Alejandro Colomar wrote: > Hi Steven, Jiri, > > On Wed, Aug 07, 2024 at 04:27:34PM GMT, Steven Rostedt wrote: > > Just in case nobody pinged you, the rest of the series is now in Linus's > > tree. > > Thanks for the ping! > > I have prepared some tweaks to the patch (see below). > Also, I have some doubts. The prototype shows that it has no arguments > (void), but the text said that arguments, if any, are arch-specific. > Does any arch have arguments? Should we use a variadic prototype (...)? hi, there are no args for x86.. it's there just to note that it might be different on other archs, so not sure what man page should say in such case.. keeping (void) is fine with me > > Please add the changes proposed below to your patch, tweak anything if > you consider it appropriate) and send it as v10. it looks good to me, thanks a lot Acked-by: From: Jiri Olsa <jolsa@kernel.org> jirka > > Have a lovely day! > Alex > > > diff --git i/man/man2/uretprobe.2 w/man/man2/uretprobe.2 > index cf1c2b0d8..51b566998 100644 > --- i/man/man2/uretprobe.2 > +++ w/man/man2/uretprobe.2 > @@ -7,50 +7,43 @@ .SH NAME > uretprobe \- execute pending return uprobes > .SH SYNOPSIS > .nf > -.B int uretprobe(void) > +.B int uretprobe(void); > .fi > .SH DESCRIPTION > -The > .BR uretprobe () > -system call is an alternative to breakpoint instructions for triggering return > -uprobe consumers. > +is an alternative to breakpoint instructions > +for triggering return uprobe consumers. > .P > Calls to > .BR uretprobe () > -system call are only made from the user-space trampoline provided by the kernel. > +are only made from the user-space trampoline provided by the kernel. > Calls from any other place result in a > .BR SIGILL . > -.SH RETURN VALUE > -The > +.P > +Details of the arguments (if any) passed to > .BR uretprobe () > -system call return value is architecture-specific. > +are architecture-specific. > +.SH RETURN VALUE > +The return value is architecture-specific. > .SH ERRORS > .TP > .B SIGILL > -The > .BR uretprobe () > -system call was called by a user-space program. > +was called by a user-space program. > .SH VERSIONS > -Details of the > -.BR uretprobe () > -system call behavior vary across systems. > +The behavior varies across systems. > .SH STANDARDS > None. > .SH HISTORY > -TBD > -.SH NOTES > -The > +Linux 6.11. > +.P > .BR uretprobe () > -system call was initially introduced for the x86_64 architecture > +was initially introduced for the x86_64 architecture > where it was shown to be faster than breakpoint traps. > It might be extended to other architectures. > -.P > -The > +.SH CAVEATS > .BR uretprobe () > -system call exists only to allow the invocation of return uprobe consumers. > +exists only to allow the invocation of return uprobe consumers. > It should > .B never > be called directly. > -Details of the arguments (if any) passed to > -.BR uretprobe () > -and the return value are architecture-specific. > > -- > <https://www.alejandro-colomar.es/>
On Fri, Aug 16, 2024 at 07:03:59PM GMT, Jiri Olsa wrote: > On Fri, Aug 16, 2024 at 01:42:26PM +0200, Alejandro Colomar wrote: > > Hi Steven, Jiri, > > > > On Wed, Aug 07, 2024 at 04:27:34PM GMT, Steven Rostedt wrote: > > > Just in case nobody pinged you, the rest of the series is now in Linus's > > > tree. > > > > Thanks for the ping! > > > > I have prepared some tweaks to the patch (see below). > > Also, I have some doubts. The prototype shows that it has no arguments > > (void), but the text said that arguments, if any, are arch-specific. > > Does any arch have arguments? Should we use a variadic prototype (...)? > > hi, > there are no args for x86.. it's there just to note that it might > be different on other archs, so not sure what man page should say > in such case.. keeping (void) is fine with me Hmmm, then I'll remove that paragraph. If that function is implemented in another arch and the args are different, we can change the manual page then. > > > > > Please add the changes proposed below to your patch, tweak anything if > > you consider it appropriate) and send it as v10. > > it looks good to me, thanks a lot > > Acked-by: From: Jiri Olsa <jolsa@kernel.org> Thanks! Have a lovely day! Alex > > jirka > > > > > Have a lovely day! > > Alex > > > > > > diff --git i/man/man2/uretprobe.2 w/man/man2/uretprobe.2 > > index cf1c2b0d8..51b566998 100644 > > --- i/man/man2/uretprobe.2 > > +++ w/man/man2/uretprobe.2 > > @@ -7,50 +7,43 @@ .SH NAME > > uretprobe \- execute pending return uprobes > > .SH SYNOPSIS > > .nf > > -.B int uretprobe(void) > > +.B int uretprobe(void); > > .fi > > .SH DESCRIPTION > > -The > > .BR uretprobe () > > -system call is an alternative to breakpoint instructions for triggering return > > -uprobe consumers. > > +is an alternative to breakpoint instructions > > +for triggering return uprobe consumers. > > .P > > Calls to > > .BR uretprobe () > > -system call are only made from the user-space trampoline provided by the kernel. > > +are only made from the user-space trampoline provided by the kernel. > > Calls from any other place result in a > > .BR SIGILL . > > -.SH RETURN VALUE > > -The > > +.P > > +Details of the arguments (if any) passed to > > .BR uretprobe () > > -system call return value is architecture-specific. > > +are architecture-specific. > > +.SH RETURN VALUE > > +The return value is architecture-specific. > > .SH ERRORS > > .TP > > .B SIGILL > > -The > > .BR uretprobe () > > -system call was called by a user-space program. > > +was called by a user-space program. > > .SH VERSIONS > > -Details of the > > -.BR uretprobe () > > -system call behavior vary across systems. > > +The behavior varies across systems. > > .SH STANDARDS > > None. > > .SH HISTORY > > -TBD > > -.SH NOTES > > -The > > +Linux 6.11. > > +.P > > .BR uretprobe () > > -system call was initially introduced for the x86_64 architecture > > +was initially introduced for the x86_64 architecture > > where it was shown to be faster than breakpoint traps. > > It might be extended to other architectures. > > -.P > > -The > > +.SH CAVEATS > > .BR uretprobe () > > -system call exists only to allow the invocation of return uprobe consumers. > > +exists only to allow the invocation of return uprobe consumers. > > It should > > .B never > > be called directly. > > -Details of the arguments (if any) passed to > > -.BR uretprobe () > > -and the return value are architecture-specific. > > > > -- > > <https://www.alejandro-colomar.es/> >
Hi Jiri, Steven, On Fri, Aug 16, 2024 at 08:55:47PM GMT, Alejandro Colomar wrote: > > hi, > > there are no args for x86.. it's there just to note that it might > > be different on other archs, so not sure what man page should say > > in such case.. keeping (void) is fine with me > > Hmmm, then I'll remove that paragraph. If that function is implemented > in another arch and the args are different, we can change the manual > page then. > > > > > > > > > Please add the changes proposed below to your patch, tweak anything if > > > you consider it appropriate) and send it as v10. > > > > it looks good to me, thanks a lot > > > > Acked-by: From: Jiri Olsa <jolsa@kernel.org> I have applied your patch with the tweaks I mentioned, and added several tags to the commit message. It's currently here: <https://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git/commit/?h=contrib&id=977e3eecbb81b7398defc4e4f41810ca31d63c1b> and will $soon be pushed to master. Have a lovely night! Alex
On Fri, Aug 16, 2024 at 11:56:39PM +0200, Alejandro Colomar wrote: > Hi Jiri, Steven, > > On Fri, Aug 16, 2024 at 08:55:47PM GMT, Alejandro Colomar wrote: > > > hi, > > > there are no args for x86.. it's there just to note that it might > > > be different on other archs, so not sure what man page should say > > > in such case.. keeping (void) is fine with me > > > > Hmmm, then I'll remove that paragraph. If that function is implemented > > in another arch and the args are different, we can change the manual > > page then. > > > > > > > > > > > > > Please add the changes proposed below to your patch, tweak anything if > > > > you consider it appropriate) and send it as v10. > > > > > > it looks good to me, thanks a lot > > > > > > Acked-by: From: Jiri Olsa <jolsa@kernel.org> > > I have applied your patch with the tweaks I mentioned, and added several > tags to the commit message. > > It's currently here: > <https://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git/commit/?h=contrib&id=977e3eecbb81b7398defc4e4f41810ca31d63c1b> > > and will $soon be pushed to master. > > Have a lovely night! > Alex great, thanks jirka
diff --git a/man/man2/uretprobe.2 b/man/man2/uretprobe.2 new file mode 100644 index 000000000000..cf1c2b0d852e --- /dev/null +++ b/man/man2/uretprobe.2 @@ -0,0 +1,56 @@ +.\" Copyright (C) 2024, Jiri Olsa <jolsa@kernel.org> +.\" +.\" SPDX-License-Identifier: Linux-man-pages-copyleft +.\" +.TH uretprobe 2 (date) "Linux man-pages (unreleased)" +.SH NAME +uretprobe \- execute pending return uprobes +.SH SYNOPSIS +.nf +.B int uretprobe(void) +.fi +.SH DESCRIPTION +The +.BR uretprobe () +system call is an alternative to breakpoint instructions for triggering return +uprobe consumers. +.P +Calls to +.BR uretprobe () +system call are only made from the user-space trampoline provided by the kernel. +Calls from any other place result in a +.BR SIGILL . +.SH RETURN VALUE +The +.BR uretprobe () +system call return value is architecture-specific. +.SH ERRORS +.TP +.B SIGILL +The +.BR uretprobe () +system call was called by a user-space program. +.SH VERSIONS +Details of the +.BR uretprobe () +system call behavior vary across systems. +.SH STANDARDS +None. +.SH HISTORY +TBD +.SH NOTES +The +.BR uretprobe () +system call was initially introduced for the x86_64 architecture +where it was shown to be faster than breakpoint traps. +It might be extended to other architectures. +.P +The +.BR uretprobe () +system call exists only to allow the invocation of return uprobe consumers. +It should +.B never +be called directly. +Details of the arguments (if any) passed to +.BR uretprobe () +and the return value are architecture-specific.