Linux Manual Pages development
 help / color / mirror / Atom feed
From: "Günther Noack" <gnoack3000@gmail.com>
To: Alejandro Colomar <alx+linux-man@kernel.org>
Cc: "Kuniyuki Iwashima" <kuniyu@google.com>,
	"Günther Noack" <gnoack3000@gmail.com>,
	linux-man@vger.kernel.org
Subject: [PATCH v2 3/6] man/man7/unix.7: SIOCINQ: Document behavior for SOCK_SEQPACKET
Date: Tue,  3 Nov 2026 21:21:33 +0100	[thread overview]
Message-ID: <20261103202136.13574-4-gnoack3000@gmail.com> (raw)
In-Reply-To: <20261103202136.13574-1-gnoack3000@gmail.com>

Document the SIOCINQ behavior for SOCK_SEQPACKET,
which sums up the lengths of all messages in the receive queue.

Restructure sentence order, so that socket type differences are
discussed in on paragraph, and commonalities in the next.

For reference, the SIOCINQ lookup is implemented in
unix_inq_len() in linux.git net/unix/af_unix.c.

This function first rejects SIOCINQ for listening sockets with
-EINVAL, then does a case analysis for the three types of Unix Domain
Sockets:

For SOCK_STREAM, the result is:

	return READ_ONCE(unix_sk(sk)->inq_len);

For SOCK_SEQPACKET, the result is calculated using:

	skb_queue_walk(&sk->sk_receive_queue, skb)
        	amount += unix_skb_len(skb);

For SOCK_DGRAM, the result is:

	skb = skb_peek(&sk->sk_receive_queue);
	if (skb)
		amount = skb->len;

Cc: Kuniyuki Iwashima <kuniyu@google.com>
Assisted-by: LLM
Signed-off-by: Günther Noack <gnoack3000@gmail.com>
---

Notes:
    I double checked this all in the code, and quoted the code.  Both the
    commit message and commit body were substantially edited based on the
    initial LLM-based version.  (Nevertheless, I would have likely missed
    the inaccuracy if the LLM hadn't found it.)
    
    The LLM initially just slapped an additional sentence into the
    paragraph, but that was mixing the socket-type-specific concerns with
    the general description -- I split that paragraph apart so that we
    have one paragraph for the three socket types and one for the
    socket-type-independent description.

 man/man7/unix.7 | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/man/man7/unix.7 b/man/man7/unix.7
index d0c1765dfd79..c370b021589a 100644
--- a/man/man7/unix.7
+++ b/man/man7/unix.7
@@ -605,7 +605,15 @@ .SS Ioctls
 .B SIOCINQ
 For
 .B SOCK_STREAM
+and
+.B SOCK_SEQPACKET
 sockets, this call returns the number of unread bytes in the receive buffer.
+For
+.B SOCK_DGRAM
+sockets,
+this call returns size of the next pending datagram,
+or 0 when no datagram is pending.
+.IP
 The socket must not be in LISTEN state, otherwise an error
 .RB ( EINVAL )
 is returned.
@@ -625,13 +633,6 @@ .SS Ioctls
 .\" That number is normally larger than the number of bytes of pending
 .\" output.  Since this info is, from userland's point of view, imprecise,
 .\" and it may well change, probably best not to document this now.
-For
-.B SOCK_DGRAM
-sockets,
-the returned value is the same as
-for Internet domain datagram sockets;
-see
-.BR udp (7).
 .SH ERRORS
 .TP
 .B EADDRINUSE
-- 
2.56.0


  parent reply	other threads:[~2026-11-03 20:22 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-03 20:21 [PATCH v2 0/6] {unix,socket,bind}.7: General Unix Domain Socket fixes Günther Noack
2026-11-03 20:21 ` [PATCH v2 1/6] man/man7/socket.7: SO_PEEK_OFF: This option is no longer specific to unix(7) Günther Noack
2026-11-03 20:21 ` [PATCH v2 2/6] man/man7/unix.7: SO_PEERCRED: Also works for SOCK_SEQPACKET Günther Noack
2026-11-03 20:21 ` Günther Noack [this message]
2026-11-03 20:21 ` [PATCH v2 4/6] man/man7/unix.7: Explain Abstract UDS scoping to the network namespace Günther Noack
2026-11-03 20:21 ` [PATCH v2 5/6] man/man2/bind.2: ERRORS: EACCES: Write permission on the directory is required Günther Noack
2026-11-03 20:21 ` [PATCH v2 6/6] man/man7/unix.7: ERRORS: Document EACCES, EAGAIN, EMSGSIZE, ENOSPC, and EPERM Günther Noack

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=20261103202136.13574-4-gnoack3000@gmail.com \
    --to=gnoack3000@gmail.com \
    --cc=alx+linux-man@kernel.org \
    --cc=kuniyu@google.com \
    --cc=linux-man@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