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>
Subject: [PATCH 22/22] man2: Add uprobe syscall page
Date: Mon, 21 Apr 2025 23:44:22 +0200 [thread overview]
Message-ID: <20250421214423.393661-23-jolsa@kernel.org> (raw)
In-Reply-To: <20250421214423.393661-1-jolsa@kernel.org>
Adding man page for new uprobe syscall.
Cc: Alejandro Colomar <alx@kernel.org>
Signed-off-by: Jiri Olsa <jolsa@kernel.org>
---
man/man2/uprobe.2 | 49 ++++++++++++++++++++++++++++++++++++++++++++
man/man2/uretprobe.2 | 2 ++
2 files changed, 51 insertions(+)
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..2b01a5ab5f3e
--- /dev/null
+++ b/man/man2/uprobe.2
@@ -0,0 +1,49 @@
+.\" Copyright (C) 2024, Jiri Olsa <jolsa@kernel.org>
+.\"
+.\" SPDX-License-Identifier: Linux-man-pages-copyleft
+.\"
+.TH uprobe 2 (date) "Linux man-pages (unreleased)"
+.SH NAME
+uprobe
+\-
+execute pending entry uprobes
+.SH SYNOPSIS
+.nf
+.B int uprobe(void);
+.fi
+.SH DESCRIPTION
+.BR uprobe ()
+is an alternative to breakpoint instructions
+for triggering entry uprobe consumers.
+.P
+Calls to
+.BR uprobe ()
+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 return value is architecture-specific.
+.SH ERRORS
+.TP
+.B SIGILL
+.BR uprobe ()
+was called by a user-space program.
+.SH VERSIONS
+The behavior varies across systems.
+.SH STANDARDS
+None.
+.SH HISTORY
+TBD
+.P
+.BR uprobe ()
+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.
+.SH CAVEATS
+.BR uprobe ()
+exists only to allow the invocation of entry uprobe consumers.
+It should
+.B never
+be called directly.
+.SH SEE ALSO
+.BR uretprobe (2)
diff --git a/man/man2/uretprobe.2 b/man/man2/uretprobe.2
index bbbfb0c59335..bb8bf4e32e5d 100644
--- a/man/man2/uretprobe.2
+++ b/man/man2/uretprobe.2
@@ -45,3 +45,5 @@ exists only to allow the invocation of return uprobe consumers.
It should
.B never
be called directly.
+.SH SEE ALSO
+.BR uprobe (2)
--
2.49.0
next prev parent reply other threads:[~2025-04-21 21:48 UTC|newest]
Thread overview: 74+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-04-21 21:44 [PATCH perf/core 00/22] uprobes: Add support to optimize usdt probes on x86_64 Jiri Olsa
2025-04-21 21:44 ` [PATCH perf/core 01/22] uprobes: Rename arch_uretprobe_trampoline function Jiri Olsa
2025-04-21 21:44 ` [PATCH perf/core 02/22] uprobes: Make copy_from_page global Jiri Olsa
2025-04-21 21:44 ` [PATCH perf/core 03/22] uprobes: Move ref_ctr_offset update out of uprobe_write_opcode Jiri Olsa
2025-04-22 23:48 ` Andrii Nakryiko
2025-04-27 14:13 ` Oleg Nesterov
2025-04-28 10:51 ` Jiri Olsa
2025-04-29 13:44 ` Jiri Olsa
2025-05-06 13:11 ` Jiri Olsa
2025-05-06 14:01 ` Oleg Nesterov
2025-05-08 22:56 ` Jiri Olsa
2025-05-12 13:37 ` Oleg Nesterov
2025-04-21 21:44 ` [PATCH perf/core 04/22] uprobes: Add uprobe_write function Jiri Olsa
2025-04-21 21:44 ` [PATCH perf/core 05/22] uprobes: Add nbytes argument to uprobe_write Jiri Olsa
2025-04-22 23:48 ` Andrii Nakryiko
2025-04-21 21:44 ` [PATCH perf/core 06/22] uprobes: Add is_register argument to uprobe_write and uprobe_write_opcode Jiri Olsa
2025-04-22 23:48 ` Andrii Nakryiko
2025-04-21 21:44 ` [PATCH perf/core 07/22] uprobes: Remove breakpoint in unapply_uprobe under mmap_write_lock Jiri Olsa
2025-04-22 23:48 ` Andrii Nakryiko
2025-04-27 14:24 ` Oleg Nesterov
2025-04-28 11:11 ` Jiri Olsa
2025-04-28 11:40 ` Oleg Nesterov
2025-04-21 21:44 ` [PATCH perf/core 08/22] uprobes/x86: Add mapping for optimized uprobe trampolines Jiri Olsa
2025-04-22 23:51 ` Andrii Nakryiko
2025-04-27 14:56 ` Oleg Nesterov
2025-04-27 17:34 ` Oleg Nesterov
2025-04-28 13:48 ` Jiri Olsa
2025-04-27 18:04 ` Oleg Nesterov
2025-04-28 13:52 ` Jiri Olsa
2025-04-21 21:44 ` [PATCH perf/core 09/22] uprobes/x86: Add uprobe syscall to speed up uprobe Jiri Olsa
2025-04-22 23:48 ` Andrii Nakryiko
2025-04-27 15:51 ` Oleg Nesterov
2025-04-21 21:44 ` [PATCH perf/core 10/22] uprobes/x86: Add support to optimize uprobes Jiri Olsa
2025-04-23 0:04 ` Andrii Nakryiko
2025-04-24 12:49 ` Jiri Olsa
2025-04-24 16:06 ` Andrii Nakryiko
2025-04-27 17:11 ` Oleg Nesterov
2025-04-28 13:24 ` Jiri Olsa
2025-04-28 13:24 ` Jiri Olsa
2025-04-21 21:44 ` [PATCH perf/core 11/22] selftests/bpf: Use 5-byte nop for x86 usdt probes Jiri Olsa
2025-04-23 17:33 ` Andrii Nakryiko
2025-04-24 12:49 ` Jiri Olsa
2025-04-24 16:29 ` Andrii Nakryiko
2025-04-24 18:20 ` Andrii Nakryiko
2025-04-25 13:20 ` Jiri Olsa
2025-04-21 21:44 ` [PATCH perf/core 12/22] selftests/bpf: Reorg the uprobe_syscall test function Jiri Olsa
2025-04-23 17:34 ` Andrii Nakryiko
2025-04-21 21:44 ` [PATCH perf/core 13/22] selftests/bpf: Rename uprobe_syscall_executed prog to test_uretprobe_multi Jiri Olsa
2025-04-23 17:36 ` Andrii Nakryiko
2025-04-24 12:49 ` Jiri Olsa
2025-04-21 21:44 ` [PATCH perf/core 14/22] selftests/bpf: Add uprobe/usdt syscall tests Jiri Olsa
2025-04-23 17:40 ` Andrii Nakryiko
2025-04-24 12:49 ` Jiri Olsa
2025-04-21 21:44 ` [PATCH perf/core 15/22] selftests/bpf: Add hit/attach/detach race optimized uprobe test Jiri Olsa
2025-04-23 17:42 ` Andrii Nakryiko
2025-04-24 12:51 ` Jiri Olsa
2025-04-24 16:30 ` Andrii Nakryiko
2025-04-21 21:44 ` [PATCH perf/core 16/22] selftests/bpf: Add uprobe syscall sigill signal test Jiri Olsa
2025-04-21 21:44 ` [PATCH perf/core 17/22] selftests/bpf: Add optimized usdt variant for basic usdt test Jiri Olsa
2025-04-23 17:44 ` Andrii Nakryiko
2025-04-21 21:44 ` [PATCH perf/core 18/22] selftests/bpf: Add uprobe_regs_equal test Jiri Olsa
2025-04-23 17:46 ` Andrii Nakryiko
2025-04-24 12:51 ` Jiri Olsa
2025-04-21 21:44 ` [PATCH perf/core 19/22] selftests/bpf: Change test_uretprobe_regs_change for uprobe and uretprobe Jiri Olsa
2025-04-21 21:44 ` [PATCH perf/core 20/22] seccomp: passthrough uprobe systemcall without filtering Jiri Olsa
2025-04-21 23:04 ` Kees Cook
2025-04-21 21:44 ` [PATCH perf/core 21/22] selftests/seccomp: validate uprobe syscall passes through seccomp Jiri Olsa
2025-04-21 23:04 ` Kees Cook
2025-04-21 21:44 ` Jiri Olsa [this message]
2025-04-22 7:00 ` [PATCH 22/22] man2: Add uprobe syscall page Alejandro Colomar
2025-04-22 14:01 ` Jiri Olsa
2025-04-22 20:45 ` Alejandro Colomar
2025-05-01 21:26 ` Alejandro Colomar
2025-05-02 8:47 ` Jiri Olsa
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=20250421214423.393661-23-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=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
all inboxes | Powered by JetHome®