Re: [PATCHv5 22/22] man2: Add uprobe syscall page

[Masami Hiramatsu (Google) <mhiramat@kernel.org>]

On Fri, 11 Jul 2025 10:29:30 +0200
Jiri Olsa <jolsa@kernel.org> wrote:

> Changing uretprobe syscall man page to be shared with new
> uprobe syscall man page.
> 

Looks good to me.

Reviewed-by: Masami Hiramatsu (Google) <mhiramat@kernel.org>

Thanks,

> Cc: Alejandro Colomar <alx@kernel.org>
> Reviewed-by: Alejandro Colomar <alx@kernel.org>
> Signed-off-by: Jiri Olsa <jolsa@kernel.org>
> ---
>  man/man2/uprobe.2    |  1 +
>  man/man2/uretprobe.2 | 36 ++++++++++++++++++++++++------------
>  2 files changed, 25 insertions(+), 12 deletions(-)
>  create mode 100644 man/man2/uprobe.2
> 
> diff --git a/man/man2/uprobe.2 b/man/man2/uprobe.2
> new file mode 100644
> index 000000000000..ea5ccf901591
> --- /dev/null
> +++ b/man/man2/uprobe.2
> @@ -0,0 +1 @@
> +.so man2/uretprobe.2
> diff --git a/man/man2/uretprobe.2 b/man/man2/uretprobe.2
> index bbbfb0c59335..df0e5d92e5ed 100644
> --- a/man/man2/uretprobe.2
> +++ b/man/man2/uretprobe.2
> @@ -2,22 +2,28 @@
>  .\"
>  .\" SPDX-License-Identifier: Linux-man-pages-copyleft
>  .\"
> -.TH uretprobe 2 (date) "Linux man-pages (unreleased)"
> +.TH uprobe 2 (date) "Linux man-pages (unreleased)"
>  .SH NAME
> +uprobe,
>  uretprobe
>  \-
> -execute pending return uprobes
> +execute pending entry or return uprobes
>  .SH SYNOPSIS
>  .nf
> +.B int uprobe(void);
>  .B int uretprobe(void);
>  .fi
>  .SH DESCRIPTION
> +.BR uprobe ()
> +is an alternative to breakpoint instructions
> +for triggering entry uprobe consumers.
> +.P
>  .BR uretprobe ()
>  is an alternative to breakpoint instructions
>  for triggering return uprobe consumers.
>  .P
>  Calls to
> -.BR uretprobe ()
> +these system calls
>  are only made from the user-space trampoline provided by the kernel.
>  Calls from any other place result in a
>  .BR SIGILL .
> @@ -26,22 +32,28 @@ The return value is architecture-specific.
>  .SH ERRORS
>  .TP
>  .B SIGILL
> -.BR uretprobe ()
> -was called by a user-space program.
> +These system calls
> +were called by a user-space program.
>  .SH VERSIONS
>  The behavior varies across systems.
>  .SH STANDARDS
>  None.
>  .SH HISTORY
> +.TP
> +.BR uprobe ()
> +TBD
> +.TP
> +.BR uretprobe ()
>  Linux 6.11.
>  .P
> -.BR uretprobe ()
> -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.
> +These system calls
> +were initially introduced for the x86_64 architecture
> +where they were shown to be faster than breakpoint traps.
> +They might be extended to other architectures.
>  .SH CAVEATS
> -.BR uretprobe ()
> -exists only to allow the invocation of return uprobe consumers.
> -It should
> +These system calls
> +exist only to allow the invocation of
> +entry or return uprobe consumers.
> +They should
>  .B never
>  be called directly.
> -- 
> 2.49.0
> 


-- 
Masami Hiramatsu (Google) <mhiramat@kernel.org>