Re: [PATCH liburing v2 4/4] man/io_uring_prep_getsockname.3: Add man page

[Jens Axboe <axboe@kernel.dk>]

On 11/25/25 2:27 PM, Gabriel Krisman Bertazi wrote:
> Signed-off-by: Gabriel Krisman Bertazi <krisman@suse.de>
> ---
>  man/io_uring_prep_getsockname.3 | 76 +++++++++++++++++++++++++++++++++
>  1 file changed, 76 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..71e65f1d
> --- /dev/null
> +++ b/man/io_uring_prep_getsockname.3
> @@ -0,0 +1,76 @@
> +.\" Copyright (C) 2024 SUSE LLC.
> +.\"
> +.\" SPDX-License-Identifier: LGPL-2.0-or-later
> +.\"
> +.TH io_uring_prep_getsockname 3 "Oct 23, 2025" "liburing-2.11" "liburing Manual"

Should be 2.13 at this point, as that will be the next release.

> +.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 ");"

Line up the arguments with the first one.

> +.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.

Space after sockfd and before '.'.

> +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 0

Probably

is set to
.B 0
or the peer address if

> +or the peer address if
> +.IR peer
> +is set to 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.

cqe->res is always negative, so it'd be -ENOTSUP.

Other than these nits, looks good! Thanks for writing it.

-- 
Jens Axboe