Re: [PATCHv8 9/9] man2: Add uretprobe syscall page

Alejandro Colomar
2024-08-16T11:42:32Z

[-- Attachment #1: Type: text/plain, Size: 2637 bytes --]

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.

--
<https://www.alejandro-colomar.es/>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]