All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH v3 0/1] {unix,socket,bind}.7: General Unix Domain Socket fixes
@ 2026-11-20 13:25 Günther Noack
  2026-11-20 13:25 ` [PATCH v3 1/1] man/man7/unix.7: ERRORS: Document EACCES, EAGAIN, EMSGSIZE, ENOSPC, and EPERM Günther Noack
  0 siblings, 1 reply; 2+ messages in thread
From: Günther Noack @ 2026-11-20 13:25 UTC (permalink / raw)
  To: Alejandro Colomar; +Cc: Günther Noack, linux-man

Hello!

This is patch set (A) spun off from the "Documentation fixes in
unix(7)" patch set [1], which is now split into these three parts:

 (A) Miscellaneous fixes, mostly in unix.7, one in socket.7     <-- this one
 (B) Socket options and Socket-level Control Messages (SCM_*)
 (C) sock_diag.7

This patch set fixes miscellaneous inaccuracies and documents missing
error codes.  It applies cleanly on the current "master".

Thank you for your reviews of v1 and v2 of the still-joined patch set,
as well as of v1 of the split patch set.

Changes in v3 (split):

* Mention EADDRINUSE in commit message for error code patch.
* Dropped already-merged commits (all but the one about error codes)

Changes in v2 (split):

* Mention commit hashes in commit messages, not in groff comments
* In SIOCINQ docs, describe SOCK_STREAM and SOCK_SEQPACKET together
* s/Named Unix Domain Sockets/pathname Unix Domain Sockets/
* Abstract namespaces: Wording simplifications
* Error descriptions: Wording simplifications
* Dropped commits:
  * Drop the commit that documented SOCK_RAW as alias for SOCK_DGRAM
  * Drop the commit that documented the socket() "protocol" argument 0
    is acceptable to avoid EPROTONOSUPPORT
  * Drop commits that already made it into the master branch.

Changes in v1 (split):

* Some commit message rewording (especially quoted the kernel code
  more directly).
* In the Abstract UDS scoping commit below, reworded the subsequent
  paragraph sligthly to avoid confusion with the "namespace"
  terminology being used differently in adjacent paragraphs.
* I removed the commit that changed the wording about Out-of-Band
  messaging, per Kuniyuki's suggestion in [2].

v1: https://lore.kernel.org/all/20261021210800.27338-2-gnoack3000@gmail.com/
v2: https://lore.kernel.org/all/20261103202136.13574-1-gnoack3000@gmail.com/

This patch set has been produced with the help of a LLM, which was
helpful for spotting a long list of inaccuracies, comparing the
documentation with the kernel implementation.  (More details in [1])

–Günther

[1] https://lore.kernel.org/all/20261018173712.27670-1-gnoack3000@gmail.com/
[2] https://lore.kernel.org/all/CAAVpQUBh+J-aBLbkpzT7qmt7B714O529HWcTuQsVLT4wLBnDJA@mail.gmail.com/


Günther Noack (1):
  man/man7/unix.7: ERRORS: Document EACCES, EAGAIN, EMSGSIZE, ENOSPC,
    and EPERM

 man/man7/unix.7 | 36 ++++++++++++++++++++++++++++++++++--
 1 file changed, 34 insertions(+), 2 deletions(-)

-- 
2.56.1


^ permalink raw reply	[flat|nested] 2+ messages in thread

* [PATCH v3 1/1] man/man7/unix.7: ERRORS: Document EACCES, EAGAIN, EMSGSIZE, ENOSPC, and EPERM
  2026-11-20 13:25 [PATCH v3 0/1] {unix,socket,bind}.7: General Unix Domain Socket fixes Günther Noack
@ 2026-11-20 13:25 ` Günther Noack
  0 siblings, 0 replies; 2+ messages in thread
From: Günther Noack @ 2026-11-20 13:25 UTC (permalink / raw)
  To: Alejandro Colomar; +Cc: Günther Noack, linux-man, Kuniyuki Iwashima

These are all returned directly from linux.git net/unix/af_unix.c:

EACCES
	unix_find_bsd() checks path_permission(&path, MAY_WRITE) on the
	socket file of the remote address.  The rule was already described
	in prose, but the error was not listed.

EAGAIN
	unix_stream_connect() returns -EAGAIN when the listener's backlog
	is full and the socket is nonblocking (there is no EINPROGRESS for
	AF_UNIX).  unix_dgram_sendmsg() returns -EAGAIN when the receiver's
	queue is full and the send would block.

EMSGSIZE
	unix_dgram_sendmsg() fails if 'len > sk->sk_sndbuf - 32'.  This is
	the limit described in "Sockets API".

ENOSPC
	unix_autobind() fails when all 2^20 autobind names are taken.

EPERM
	unix_dgram_connect() and unix_dgram_sendmsg() fail if
	!unix_may_send(), that is, if the target datagram socket is
	connected to a socket other than the caller's.

	This is not something that the remote end normally does,
	but it's a possible corner case.

For EADDRINUSE, simplify and shorten the wording.

Cc: Kuniyuki Iwashima <kuniyu@google.com>
Assisted-by: LLM
Reviewed-by: Kuniyuki Iwashima <kuniyu@google.com>
Signed-off-by: Günther Noack <gnoack3000@gmail.com>
---
 man/man7/unix.7 | 36 ++++++++++++++++++++++++++++++++++--
 1 file changed, 34 insertions(+), 2 deletions(-)

diff --git a/man/man7/unix.7 b/man/man7/unix.7
index b7b14793c794..61f06a74359b 100644
--- a/man/man7/unix.7
+++ b/man/man7/unix.7
@@ -676,9 +676,24 @@ .SS Ioctls
 .\" and it may well change, probably best not to document this now.
 .SH ERRORS
 .TP
+.B EACCES
+Write permission is denied on the socket file
+specified as the remote address to
+.BR connect (2)
+or
+.BR sendto (2)
+(see "Pathname socket ownership and permissions", above).
+.TP
 .B EADDRINUSE
-The specified local address is already in use or the filesystem socket
-object already exists.
+The specified local address is already in use
+or the file already exists.
+.TP
+.B EAGAIN
+The socket is nonblocking, and either
+.BR connect (2)
+was called on a stream or sequenced-packet socket
+and the backlog of the listening socket is full,
+or a datagram was sent to a socket whose receive queue is full.
 .TP
 .B EBADF
 This error can occur for
@@ -715,6 +730,11 @@ .SH ERRORS
 called on an already connected socket or a target address was
 specified on a connected socket.
 .TP
+.B EMSGSIZE
+The datagram to be sent is larger than the limit imposed by the
+.B SO_SNDBUF
+socket option (see "Sockets API", above).
+.TP
 .B ENFILE
 The system-wide limit on the total number of open files has been reached.
 .TP
@@ -726,6 +746,11 @@ .SH ERRORS
 .B ENOMEM
 Out of memory.
 .TP
+.B ENOSPC
+The socket was to be autobound,
+but all autobind addresses are in use
+(see "Autobind feature", above).
+.TP
 .B ENOTCONN
 Socket operation needs a target address, but the socket is not connected.
 .TP
@@ -737,6 +762,13 @@ .SH ERRORS
 The sender passed invalid credentials in the
 .IR "struct ucred" .
 .TP
+.B EPERM
+.BR connect (2)
+or
+.BR sendto (2)
+specified a datagram socket as the remote address,
+but that socket is connected to a different socket.
+.TP
 .B EPIPE
 Remote socket was closed on a stream socket.
 If enabled, a
-- 
2.56.1


^ permalink raw reply related	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2026-11-20 13:25 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-11-20 13:25 [PATCH v3 0/1] {unix,socket,bind}.7: General Unix Domain Socket fixes Günther Noack
2026-11-20 13:25 ` [PATCH v3 1/1] man/man7/unix.7: ERRORS: Document EACCES, EAGAIN, EMSGSIZE, ENOSPC, and EPERM Günther Noack

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.