Re: [PATCHv8 9/9] man2: Add uretprobe syscall page
From: Masami Hiramatsu (Google) <mhiramat@kernel.org>
Date: 2024-06-11 14:30:29
Also in:
bpf, linux-api, linux-trace-kernel, lkml
On Tue, 11 Jun 2024 13:21:58 +0200 Jiri Olsa [off-list ref] 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,
quoted hunk ↗ jump to hunk
--- man/man2/uretprobe.2 | 56 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 man/man2/uretprobe.2diff --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) [off-list ref]