From: Jiri Olsa <jolsa@kernel.org>
To: Oleg Nesterov <oleg@redhat.com>,
Peter Zijlstra <peterz@infradead.org>,
Andrii Nakryiko <andrii@kernel.org>
Cc: "Alejandro Colomar" <alx@kernel.org>,
bpf@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-trace-kernel@vger.kernel.org, x86@kernel.org,
"Song Liu" <songliubraving@fb.com>, "Yonghong Song" <yhs@fb.com>,
"John Fastabend" <john.fastabend@gmail.com>,
"Hao Luo" <haoluo@google.com>,
"Steven Rostedt" <rostedt@goodmis.org>,
"Masami Hiramatsu" <mhiramat@kernel.org>,
"Alan Maguire" <alan.maguire@oracle.com>,
"David Laight" <David.Laight@ACULAB.COM>,
"Thomas Weißschuh" <thomas@t-8ch.de>,
"Ingo Molnar" <mingo@kernel.org>, "Jann Horn" <jannh@google.com>
Subject: [PATCH 3/3] man2: Add uprobe syscall page
Date: Fri, 5 Sep 2025 22:57:31 +0200 [thread overview]
Message-ID: <20250905205731.1961288-4-jolsa@kernel.org> (raw)
In-Reply-To: <20250905205731.1961288-1-jolsa@kernel.org>
Changing uretprobe syscall man page to be shared with new
uprobe syscall man page.
Cc: Alejandro Colomar <alx@kernel.org>
Signed-off-by: Jiri Olsa <jolsa@kernel.org>
---
man/man2/uprobe.2 | 1 +
man/man2/uretprobe.2 | 42 +++++++++++++++++++++++++++++-------------
2 files changed, 30 insertions(+), 13 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 c81d4c5313a3..a1e4a1fa56f4 100644
--- a/man/man2/uretprobe.2
+++ b/man/man2/uretprobe.2
@@ -2,46 +2,62 @@
.\"
.\" 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 .
+.BR SIGILL
+or error value (see below).
+
.SH RETURN VALUE
The return value is architecture-specific.
.SH ERRORS
.TP
.B SIGILL
-.BR uretprobe ()
-was called by a user-space program.
+uretprobe() was called by a user-space program.
+.TP
+.B ENXIO
+uprobe() was 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.51.0
next prev parent reply other threads:[~2025-09-05 20:58 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-05 20:57 [PATCH perf/core 0/3] uprobes/x86: change error path for uprobe syscall Jiri Olsa
2025-09-05 20:57 ` [PATCH perf/core 1/3] uprobes/x86: Return error from uprobe syscall when not called from trampoline Jiri Olsa
2025-09-08 11:25 ` Oleg Nesterov
2025-09-05 20:57 ` [PATCH perf/core 2/3] selftests/bpf: Fix uprobe_sigill test for uprobe syscall error value Jiri Olsa
2025-09-05 21:40 ` Andrii Nakryiko
2025-09-05 20:57 ` Jiri Olsa [this message]
2025-09-15 11:47 ` [PATCH perf/core 0/3] uprobes/x86: change error path for uprobe syscall Peter Zijlstra
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250905205731.1961288-4-jolsa@kernel.org \
--to=jolsa@kernel.org \
--cc=David.Laight@ACULAB.COM \
--cc=alan.maguire@oracle.com \
--cc=alx@kernel.org \
--cc=andrii@kernel.org \
--cc=bpf@vger.kernel.org \
--cc=haoluo@google.com \
--cc=jannh@google.com \
--cc=john.fastabend@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-trace-kernel@vger.kernel.org \
--cc=mhiramat@kernel.org \
--cc=mingo@kernel.org \
--cc=oleg@redhat.com \
--cc=peterz@infradead.org \
--cc=rostedt@goodmis.org \
--cc=songliubraving@fb.com \
--cc=thomas@t-8ch.de \
--cc=x86@kernel.org \
--cc=yhs@fb.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).