'\" t
-.\" Don't change the first line, it tells man that we need tbl.
.\" This man page is Copyright (C) 1999 Andi Kleen <ak@muc.de>.
.\" and copyright (c) 1999 Matthew Wilcox.
+.\"
+.\" %%%LICENSE_START(VERBATIM_ONE_PARA)
.\" Permission is granted to distribute possibly modified copies
.\" of this page provided the header is included verbatim,
.\" and in case of nontrivial modification author and date
.\" of the modification is added to the header.
+.\" %%%LICENSE_END
.\"
.\" 2002-10-30, Michael Kerrisk, <mtk.manpages@gmail.com>
.\" Added description of SO_ACCEPTCONN
.\" Modified, 27 May 2004, Michael Kerrisk <mtk.manpages@gmail.com>
.\" Added notes on capability requirements
.\" A few small grammar fixes
+.\" 2010-06-13 Jan Engelhardt <jengelh@medozas.de>
+.\" Documented SO_DOMAIN and SO_PROTOCOL.
.\" FIXME
.\" The following are not yet documented:
-.\" SO_PEERNAME
-.\" SO_TIMESTAMPNS
-.\" SO_MARK
-.\" SO_TIMESTAMPING
-.\" SO_PROTOCOL (2.6.32)
-.\" SO_DOMAIN (2.6.32)
-.\" SO_RXQ_OVFL (2.6.33)
+.\" SO_PEERNAME (2.4?)
+.\" get only
+.\" Seems to do something similar to getpeername(), but then
+.\" why is it necessary / how does it differ?
+.\" SO_TIMESTAMPNS (2.6.22)
+.\" Documentation/networking/timestamping.txt
+.\" commit 92f37fd2ee805aa77925c1e64fd56088b46094fc
+.\" Author: Eric Dumazet <dada1@cosmosbay.com>
+.\" SO_TIMESTAMPING (2.6.30)
+.\" Documentation/networking/timestamping.txt
+.\" commit cb9eff097831007afb30d64373f29d99825d0068
+.\" Author: Patrick Ohly <patrick.ohly@intel.com>
+.\" SO_WIFI_STATUS (3.3)
+.\" commit 6e3e939f3b1bf8534b32ad09ff199d88800835a0
+.\" Author: Johannes Berg <johannes.berg@intel.com>
+.\" Also: SCM_WIFI_STATUS
+.\" SO_NOFCS (3.4)
+.\" commit 3bdc0eba0b8b47797f4a76e377dd8360f317450f
+.\" Author: Ben Greear <greearb@candelatech.com>
+.\" SO_GET_FILTER (3.8)
+.\" commit a8fc92778080c845eaadc369a0ecf5699a03bef0
+.\" Author: Pavel Emelyanov <xemul@parallels.com>
+.\" SO_REUSEPORT (3.9)
+.\" commit c617f398edd4db2b8567a28e899a88f8f574798d
+.\" https://lwn.net/Articles/542629/
+.\" SO_LOCK_FILTER (3.9)
+.\" commit d59577b6ffd313d0ab3be39cb1ab47e29bdc9182
+.\" Author: Vincent Bernat <bernat@luffy.cx>
+.\" SO_SELECT_ERR_QUEUE (3.10)
+.\" commit 7d4c04fc170087119727119074e72445f2bb192b
+.\" Author: Keller, Jacob E <jacob.e.keller@intel.com>
+.\" SO_MAX_PACING_RATE (3.13)
+.\" commit 62748f32d501f5d3712a7c372bbb92abc7c62bc7
+.\" SO_BPF_EXTENSIONS (3.14)
+.\" commit ea02f9411d9faa3553ed09ce0ec9f00ceae9885e
.\"
-.TH SOCKET 7 2008-12-03 Linux "Linux Programmer's Manual"
+.TH SOCKET 7 2014-07-08 Linux "Linux Programmer's Manual"
.SH NAME
socket \- Linux socket interface
.SH SYNOPSIS
between the user process and the network protocol stacks in the kernel.
The protocol modules are grouped into
.I protocol families
-like
-.BR AF_INET ", " AF_IPX ", " AF_PACKET
+such as
+.BR AF_INET ", " AF_IPX ", and " AF_PACKET ,
and
.I socket types
-like
+such as
.B SOCK_STREAM
or
.BR SOCK_DGRAM .
See
.BR socket (2)
for more information on families and types.
-.SS Socket Layer Functions
+.SS Socket-layer functions
These functions are used by the user process to send or receive packets
and to do other socket operations.
For more information see their respective manual pages.
.BR accept (2)
is used to get a new socket with a new incoming connection.
.BR socketpair (2)
-returns two connected anonymous sockets (only implemented for a few
+returns two connected anonymous sockets (implemented only for a few
local families like
.BR AF_UNIX )
.PP
.\" or
.\" .BR close (2).
.TE
-
.PP
An alternative to
.BR poll (2)
See the
.I Signals
discussion below.
-.SS Socket Options
-These socket options can be set by using
+.SS Socket address structures
+Each socket domain has its own format for socket addresses,
+with a domain-specific address structure.
+Each of these structures begins with an
+integer "family" field (typed as
+.IR sa_family_t )
+that indicates the type of the address structure.
+This allows
+the various system calls (e.g.,
+.BR connect (2),
+.BR bind (2),
+.BR accept (2),
+.BR getsockname (2),
+.BR getpeername (2)),
+which are generic to all socket domains,
+to determine the domain of a particular socket address.
+
+To allow any type of socket address to be passed to
+interfaces in the sockets API,
+the type
+.IR "struct sockaddr"
+is defined.
+The purpose of this type is purely to allow casting of
+domain-specific socket address types to a "generic" type,
+so as to avoid compiler warnings about type mismatches in
+calls to the sockets API.
+
+In addition, the sockets API provides the data type
+.IR "struct sockaddr_storage".
+This type
+is suitable to accommodate all supported domain-specific socket
+address structures; it is large enough and is aligned properly.
+(In particular, it is large enough to hold
+IPv6 socket addresses.)
+The structure includes the following field, which can be used to identify
+the type of socket address actually stored in the structure:
+
+.in +4n
+.nf
+ sa_family_t ss_family;
+.fi
+.in
+
+The
+.I sockaddr_storage
+structure is useful in programs that must handle socket addresses
+in a generic way
+(e.g., programs that must deal with both IPv4 and IPv6 socket addresses).
+.SS Socket options
+The socket options listed below can be set by using
.BR setsockopt (2)
and read with
.BR getsockopt (2)
with the socket level set to
.B SOL_SOCKET
-for all sockets:
+for all sockets.
+Unless otherwise noted,
+.I optval
+is a pointer to an
+.IR int .
+.\" FIXME .
+.\" In the list below, the text used to describe argument types
+.\" for each socket option should be more consistent
+.\"
.\" SO_ACCEPTCONN is in POSIX.1-2001, and its origin is explained in
.\" W R Stevens, UNPv1
.TP
.BR listen (2).
The value 0 indicates that this is not a listening socket,
the value 1 indicates that this is a listening socket.
-Can only be read
-with
-.BR getsockopt (2).
+This socket option is read-only.
.TP
.B SO_BINDTODEVICE
Bind this socket to a particular device like \(lqeth0\(rq,
If a socket is bound to an interface,
only packets received from that particular interface are processed by the
socket.
-Note that this only works for some socket types, particularly
+Note that this works only for some socket types, particularly
.B AF_INET
sockets.
It is not supported for packet sockets (use normal
-.BR bind (8)
+.BR bind (2)
there).
+
+Before Linux 3.8,
+this socket option could be set, but could not retrieved with
+.BR getsockopt (2).
+Since Linux 3.8, it is readable.
+The
+.I optlen
+argument should contain the buffer size available
+to receive the device name and is recommended to be
+.BR IFNAMSZ
+bytes.
+The real device name length is reported back in the
+.I optlen
+argument.
.TP
.B SO_BROADCAST
Set or get the broadcast flag.
-When enabled, datagram sockets
-receive packets sent to a broadcast address and they are allowed to send
+When enabled, datagram sockets are allowed to send
packets to a broadcast address.
This option has no effect on stream-oriented sockets.
.TP
.B SO_BSDCOMPAT
Enable BSD bug-to-bug compatibility.
This is used by the UDP protocol module in Linux 2.0 and 2.2.
-If enabled ICMP errors received for a UDP socket will not be passed
+If enabled, ICMP errors received for a UDP socket will not be passed
to the user program.
In later kernel versions, support for this option has been phased out:
Linux 2.4 silently ignores it, and Linux 2.6 generates a kernel warning
.B CAP_NET_ADMIN
capability or an effective user ID of 0.
.TP
+.BR SO_DOMAIN " (since Linux 2.6.32)"
+Retrieves the socket domain as an integer, returning a value such as
+.BR AF_INET6 .
+See
+.BR socket (2)
+for details.
+This socket option is read-only.
+.TP
.B SO_ERROR
Get and clear the pending socket error.
-Only valid as a
-.BR getsockopt (2).
+This socket option is read-only.
Expects an integer.
.TP
.B SO_DONTROUTE
-Don't send via a gateway, only send to directly connected hosts.
+Don't send via a gateway, send only to directly connected hosts.
The same effect can be achieved by setting the
.B MSG_DONTROUTE
flag on a socket
.BR exit (2),
it always lingers in the background.
.TP
+.BR SO_MARK " (since Linux 2.6.25)"
+.\" commit 4a19ec5800fc3bb64e2d87c4d9fdd9e636086fe0
+.\" and 914a9ab386a288d0f22252fc268ecbc048cdcbd5
+Set the mark for each packet sent through this socket
+(similar to the netfilter MARK target but socket-based).
+Changing the mark can be used for mark-based
+routing without netfilter or for packet filtering.
+Setting this option requires the
+.B CAP_NET_ADMIN
+capability.
+.TP
.B SO_OOBINLINE
If this option is enabled,
out-of-band data is directly placed into the receive data stream.
-Otherwise out-of-band data is only passed when the
+Otherwise, out-of-band data is passed only when the
.B MSG_OOB
flag is set during receiving.
.\" don't document it because it can do too much harm.
.\" FIXME Document SO_PASSSEC, added in 2.6.18; there is some info
.\" in the 2.6.18 ChangeLog
.TP
+.BR SO_PEEK_OFF " (since Linux 3.4)"
+.\" commit ef64a54f6e558155b4f149bb10666b9e914b6c54
+This option, which is currently supported only for
+.BR unix (7)
+sockets, sets the value of the "peek offset" for the
+.BR recv (2)
+system call when used with
+.BR MSG_PEEK
+flag.
+
+When this option is set to a negative value
+(it is set to \-1 for all new sockets),
+traditional behavior is provided:
+.BR recv (2)
+with the
+.BR MSG_PEEK
+flag will peek data from the front of the queue.
+
+When the option is set to a value greater than or equal to zero,
+then the next peek at data queued in the socket will occur at
+the byte offset specified by the option value.
+At the same time, the "peek offset" will be
+incremented by the number of bytes that were peeked from the queue,
+so that a subsequent peek will return the next data in the queue.
+
+If data is removed from the front of the queue via a call to
+.BR recv (2)
+(or similar) without the
+.BR MSG_PEEK
+flag, the "peek offset" will be decreased by the number of bytes removed.
+In other words, receiving data without the
+.B MSG_PEEK
+flag will cause the "peek offset" to be adjusted to maintain
+the correct relative position in the queued data,
+so that a subsequent peek will retrieve the data that would have been
+retrieved had the data not been removed.
+
+For datagram sockets, if the "peek offset" points to the middle of a packet,
+the data returned will be marked with the
+.BR MSG_TRUNC
+flag.
+
+The following example serves to illustrate the use of
+.BR SO_PEEK_OFF .
+Suppose a stream socket has the following queued input data:
+
+ aabbccddeeff
+
+.IP
+The following sequence of
+.BR recv (2)
+calls would have the effect noted in the comments:
+
+.in +4n
+.nf
+int ov = 4; // Set peek offset to 4
+setsockopt(fd, SOL_SOCKET, SO_PEEK_OFF, &ov, sizeof(ov));
+
+recv(fd, buf, 2, MSG_PEEK); // Peeks "cc"; offset set to 6
+recv(fd, buf, 2, MSG_PEEK); // Peeks "dd"; offset set to 8
+recv(fd, buf, 2, 0); // Reads "aa"; offset set to 6
+recv(fd, buf, 2, MSG_PEEK); // Peeks "ee"; offset set to 8
+.fi
+.in
+.TP
.B SO_PEERCRED
Return the credentials of the foreign process connected to this socket.
-This is only possible for connected
+This is possible only for connected
.B AF_UNIX
stream sockets and
.B AF_UNIX
.BR connect (2)
or
.BR socketpair (2).
-Argument is a
+The argument is a
.I ucred
-structure.
-Only valid as a
-.BR getsockopt (2).
+structure; define the
+.B _GNU_SOURCE
+feature test macro to obtain the definition of that structure from
+.IR <sys/socket.h> .
+This socket option is read-only.
.TP
.B SO_PRIORITY
Set the protocol-defined priority for all packets to be sent on
.B CAP_NET_ADMIN
capability.
.TP
+.BR SO_PROTOCOL " (since Linux 2.6.32)"
+Retrieves the socket protocol as an integer, returning a value such as
+.BR IPPROTO_SCTP .
+See
+.BR socket (2)
+for details.
+This socket option is read-only.
+.TP
.B SO_RCVBUF
Sets or gets the maximum socket receive buffer in bytes.
The kernel doubles this value (to allow space for bookkeeping overhead)
.BR setsockopt (2),
and this doubled value is returned by
.BR getsockopt (2).
+.\" The following thread on LMKL is quite informative:
+.\" getsockopt/setsockopt with SO_RCVBUF and SO_SNDBUF "non-standard" behavior
+.\" 17 July 2012
+.\" http://thread.gmane.org/gmane.linux.kernel/1328935
The default value is set by the
.I /proc/sys/net/core/rmem_default
file, and the maximum allowed value is set by the
If an input or output function blocks for this period of time, and
data has been sent or received, the return value of that function
will be the amount of data transferred; if no data has been transferred
-and the timeout has been reached then \-1 is returned with
+and the timeout has been reached, then \-1 is returned with
.I errno
set to
-.B EAGAIN
+.BR EAGAIN
or
-.B EWOULDBLOCK
+.BR EWOULDBLOCK ,
.\" in fact to EAGAIN
+or
+.B EINPROGRESS
+(for
+.BR connect (2))
just as if the socket was specified to be nonblocking.
-If the timeout is set to zero (the default)
+If the timeout is set to zero (the default),
then the operation will never timeout.
Timeouts only have effect for system calls that perform socket I/O (e.g.,
.BR read (2),
.BR select (2),
.BR poll (2),
.BR epoll_wait (2),
-etc.
+and so on.
.TP
.B SO_REUSEADDR
Indicates that the rules used in validating addresses supplied in a
to bind to this port for any local address.
Argument is an integer boolean flag.
.TP
+.BR SO_RXQ_OVFL " (since Linux 2.6.33)"
+.\" commit 3b885787ea4112eaa80945999ea0901bf742707f
+Indicates that an unsigned 32-bit value ancillary message (cmsg)
+should be attached to received skbs indicating
+the number of packets dropped by the socket between
+the last received packet and this received packet.
+.TP
.B SO_SNDBUF
Sets or gets the maximum socket send buffer in bytes.
The kernel doubles this value (to allow space for bookkeeping overhead)
when it is set using
.\" Most (all?) other implementations do not do this -- MTK, Dec 05
+.\" See also the comment to SO_RCVBUF (17 Jul 2012 LKML mail)
.BR setsockopt (2),
and this doubled value is returned by
.BR getsockopt (2).
for details on control messages.
.TP
.B SO_TYPE
-Gets the socket type as an integer (like
+Gets the socket type as an integer (e.g.,
.BR SOCK_STREAM ).
-Can only be read
-with
-.BR getsockopt (2).
+This socket option is read-only.
+.TP
+.BR SO_BUSY_POLL " (since Linux 3.11)"
+Sets the approximate time in microseconds to busy poll on a blocking receive
+when there is no data.
+Increasing this value requires
+.BR CAP_NET_ADMIN .
+The default for this option is controlled by the
+.I /proc/sys/net/core/busy_read
+file.
+
+The value in the
+.I /proc/sys/net/core/busy_poll
+file determines how long
+.BR select (2)
+and
+.BR poll (2)
+will busy poll when they operate on sockets with
+.BR SO_BUSY_POLL
+set and no events to report are found.
+
+In both cases,
+busy polling will only be done when the socket last received data
+from a network device that supports this option.
+
+While busy polling may improve latency of some applications,
+care must be taken when using it since this will increase
+both CPU utilization and power usage.
.SS Signals
When writing onto a connection-oriented socket that has been shut down
(by the local or the remote end)
may have already disappeared when the process reacts to the signal.
If this happens, the process should wait again because Linux
will resend the signal later.
-.\" .SS Ancillary Messages
+.\" .SS Ancillary messages
.SS /proc interfaces
The core socket networking parameters can be accessed
via files in the directory
for a description of
.IR "struct timeval" .
.\"
-This ioctl should only be used if the socket option
+This ioctl should be used only if the socket option
.B SO_TIMESTAMP
is not set on the socket.
Otherwise, it returns the timestamp of the
.I /proc
files are twice what can be observed on the wire.
-Linux will only allow port reuse with the
+Linux will allow port reuse only with the
.B SO_REUSEADDR
option
when this option was set both in the previous program that performed a
library.
.\" .SH AUTHORS
.\" This man page was written by Andi Kleen.
-.SH "SEE ALSO"
+.SH SEE ALSO
+.BR connect (2),
.BR getsockopt (2),
.BR setsockopt (2),
.BR socket (2),
.BR tcp (7),
.BR udp (7),
.BR unix (7)
+.SH COLOPHON
+This page is part of release 3.79 of the Linux
+.I man-pages
+project.
+A description of the project,
+information about reporting bugs,
+and the latest version of this page,
+can be found at
+\%http://www.kernel.org/doc/man\-pages/.
OSDN Git Service
