From: Gabriel Krisman Bertazi <krisman@suse.de>
To: Jens Axboe <axboe@kernel.dk>
Cc: Gabriel Krisman Bertazi <krisman@suse.de>,
io-uring@vger.kernel.org, csander@purestorage.com
Subject: [PATCH liburing v3 4/4] man/io_uring_prep_getsockname.3: Add man page
Date: Wed, 3 Dec 2025 14:52:18 -0500 [thread overview]
Message-ID: <20251203195223.3578559-5-krisman@suse.de> (raw)
In-Reply-To: <20251203195223.3578559-1-krisman@suse.de>
Signed-off-by: Gabriel Krisman Bertazi <krisman@suse.de>
---
since v2:
- Fix Jens comments
---
man/io_uring_prep_getsockname.3 | 78 +++++++++++++++++++++++++++++++++
1 file changed, 78 insertions(+)
create mode 100644 man/io_uring_prep_getsockname.3
diff --git a/man/io_uring_prep_getsockname.3 b/man/io_uring_prep_getsockname.3
new file mode 100644
index 00000000..de78cb40
--- /dev/null
+++ b/man/io_uring_prep_getsockname.3
@@ -0,0 +1,78 @@
+.\" Copyright (C) 2024 SUSE LLC.
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_prep_getsockname 3 "Dec 3, 2025" "liburing-2.13" "liburing Manual"
+.SH NAME
+io_uring_prep_getsockname \- prepare a getsockname or getpeername request
+.SH SYNOPSIS
+.nf
+.B #include <sys/socket.h>
+.B #include <liburing.h>
+.PP
+.BI "void io_uring_prep_getsockname(struct io_uring_sqe *" sqe ","
+.BI " int " sockfd ","
+.BI " struct sockaddr *" sockaddr ","
+.BI " socklen_t *" sockaddr_len ","
+.BI " int " peer ");"
+.fi
+.SH DESCRIPTION
+The
+.BR io_uring_prep_getsockname (3)
+function prepares a getsockname/getpeername request.
+The submission queue entry
+.I sqe
+is setup to fetch the locally bound address or peer address of the socket
+file descriptor pointed by
+.IR sockfd .
+The parameter
+.IR sockaddr
+points to a region of size
+.IR sockaddr_len
+where the output is written.
+.IR sockaddr_len
+is modified by the kernel to indicate how many bytes were written.
+The output address is the locally bound address if
+.IR peer
+is set to
+.B 0
+or the peer address if
+.IR peer
+is set to
+.BR 1 .
+
+This function prepares an async
+.BR getsockname (2)
+or
+.BR getpeername (2)
+request. See those man pages for details.
+
+.SH RETURN VALUE
+None
+.SH ERRORS
+The CQE
+.I res
+field will contain the result of the operation. See the related man page for
+details on possible values. Note that where synchronous system calls will return
+.B -1
+on failure and set
+.I errno
+to the actual error value, io_uring never uses
+.IR errno .
+Instead it returns the negated
+.I errno
+directly in the CQE
+.I res
+field.
+.BR
+Differently from the equivalent system calls, if the user attempts to
+use this operation on a non-socket file descriptor, the CQE error result
+is
+.IR -ENOTSUP
+instead of
+.IR ENOSOCK.
+.SH SEE ALSO
+.BR io_uring_get_sqe (3),
+.BR io_uring_submit (3),
+.BR io_uring_prep_getsockname (2)
+.BR io_uring_prep_getpeername (2)
--
2.52.0
next prev parent reply other threads:[~2025-12-03 19:52 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-12-03 19:52 [PATCH liburing v3 0/4] liburing: getsockname support Gabriel Krisman Bertazi
2025-12-03 19:52 ` [PATCH liburing v3 1/4] liburing: Introduce getsockname operation Gabriel Krisman Bertazi
2025-12-03 19:52 ` [PATCH liburing v3 2/4] test/bind-listen.t: Use ephemeral port Gabriel Krisman Bertazi
2025-12-03 19:52 ` [PATCH liburing v3 3/4] bind-listen.t: Add tests for getsockname Gabriel Krisman Bertazi
2025-12-03 19:52 ` Gabriel Krisman Bertazi [this message]
2025-12-03 20:23 ` [PATCH liburing v3 0/4] liburing: getsockname support Jens Axboe
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=20251203195223.3578559-5-krisman@suse.de \
--to=krisman@suse.de \
--cc=axboe@kernel.dk \
--cc=csander@purestorage.com \
--cc=io-uring@vger.kernel.org \
/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