On Tue, May 21, 2024 at 10:54:36PM +0200, Alejandro Colomar wrote: > Hi Jirka, > > On Tue, May 21, 2024 at 10:24:30PM GMT, Jiri Olsa wrote: > > how about the change below? > > Much better. I still have a few comments below. :-) > > > > > thanks, > > jirka > > > > > > --- > > diff --git a/man/man2/uretprobe.2 b/man/man2/uretprobe.2 > > new file mode 100644 > > index 000000000000..959b7a47102b > > --- /dev/null > > +++ b/man/man2/uretprobe.2 > > @@ -0,0 +1,55 @@ > > +.\" Copyright (C) 2024, Jiri Olsa <jolsa@xxxxxxxxxx> > > +.\" > > +.\" 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 > > +.BR SIGILL > > This should be a tagged paragraph, preceeded with '.TP'. See any manual > page with an ERRORS section for an example. > > Also, BR is Bold alternating with Roman, but this is just bold, so it > should use '.B'. > > .TP > .B SIGILL ok > > > +The > > +.BR uretprobe () > > +system call was called by user. > > +.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 > > We have a strong-ish limit at column 80. Please break after > 'architecture', which is a clause boundary. > ok, thanks jirka --- diff --git a/man/man2/uretprobe.2 b/man/man2/uretprobe.2 new file mode 100644 index 000000000000..5b5f340b59b6 --- /dev/null +++ b/man/man2/uretprobe.2 @@ -0,0 +1,56 @@ +.\" Copyright (C) 2024, Jiri Olsa <jolsa@xxxxxxxxxx> +.\" +.\" 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 user. +.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.
