2008-08-08 16:41:48 +00:00
|
|
|
.\" This man page is Copyright (C) 1999 Andi Kleen <ak@muc.de>.
|
|
|
|
.\" 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.
|
|
|
|
.\" $Id: udp.7,v 1.7 2000/01/22 01:55:05 freitag Exp $
|
|
|
|
.\"
|
2010-06-13 03:00:58 +00:00
|
|
|
.TH UDP 7 2010-06-13 "Linux" "Linux Programmer's Manual"
|
2008-08-08 16:41:48 +00:00
|
|
|
.SH NAME
|
|
|
|
udp \- User Datagram Protocol for IPv4
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.B #include <sys/socket.h>
|
|
|
|
.br
|
|
|
|
.B #include <netinet/in.h>
|
|
|
|
.sp
|
2008-08-08 16:47:53 +00:00
|
|
|
.B udp_socket = socket(AF_INET, SOCK_DGRAM, 0);
|
2008-08-08 16:41:48 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
This is an implementation of the User Datagram Protocol
|
|
|
|
described in RFC\ 768.
|
|
|
|
It implements a connectionless, unreliable datagram packet service.
|
|
|
|
Packets may be reordered or duplicated before they arrive.
|
|
|
|
UDP generates and checks checksums to catch transmission errors.
|
|
|
|
|
|
|
|
When a UDP socket is created,
|
|
|
|
its local and remote addresses are unspecified.
|
|
|
|
Datagrams can be sent immediately using
|
|
|
|
.BR sendto (2)
|
|
|
|
or
|
|
|
|
.BR sendmsg (2)
|
|
|
|
with a valid destination address as an argument.
|
|
|
|
When
|
|
|
|
.BR connect (2)
|
2008-11-21 22:43:46 +00:00
|
|
|
is called on the socket, the default destination address is set and
|
2008-08-08 16:41:48 +00:00
|
|
|
datagrams can now be sent using
|
|
|
|
.BR send (2)
|
|
|
|
or
|
|
|
|
.BR write (2)
|
|
|
|
without specifying a destination address.
|
|
|
|
It is still possible to send to other destinations by passing an
|
|
|
|
address to
|
|
|
|
.BR sendto (2)
|
|
|
|
or
|
|
|
|
.BR sendmsg (2).
|
2008-11-21 22:43:46 +00:00
|
|
|
In order to receive packets, the socket can be bound to a local
|
2008-08-08 16:41:48 +00:00
|
|
|
address first by using
|
|
|
|
.BR bind (2).
|
|
|
|
Otherwise the socket layer will automatically assign
|
|
|
|
a free local port out of the range defined by
|
2009-09-28 08:42:15 +00:00
|
|
|
.I /proc/sys/net/ipv4/ip_local_port_range
|
2008-08-08 16:41:48 +00:00
|
|
|
and bind the socket to
|
|
|
|
.BR INADDR_ANY .
|
|
|
|
|
|
|
|
All receive operations return only one packet.
|
2008-11-21 22:43:46 +00:00
|
|
|
When the packet is smaller than the passed buffer, only that much
|
|
|
|
data is returned; when it is bigger, the packet is truncated and the
|
2008-08-08 16:41:48 +00:00
|
|
|
.B MSG_TRUNC
|
|
|
|
flag is set.
|
|
|
|
.B MSG_WAITALL
|
|
|
|
is not supported.
|
|
|
|
|
|
|
|
IP options may be sent or received using the socket options described in
|
|
|
|
.BR ip (7).
|
connect.2, listen.2, send.2, uname.2, cmsg.3, proc.5, arp.7, ddp.7, icmp.7, ip.7, raw.7, socket.7, tcp.7, udp.7: Global fix: eliminate mention of the obsolete sysctl(2) interface
Many pages still mention use of the obsolete sysctl(2) system
call, or used the term "sysctls"; rewrite these mentions to
instead be in terms of /proc interfaces.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2008-11-20 20:37:11 +00:00
|
|
|
They are only processed by the kernel when the appropriate
|
2009-09-28 08:42:15 +00:00
|
|
|
.I /proc
|
connect.2, listen.2, send.2, uname.2, cmsg.3, proc.5, arp.7, ddp.7, icmp.7, ip.7, raw.7, socket.7, tcp.7, udp.7: Global fix: eliminate mention of the obsolete sysctl(2) interface
Many pages still mention use of the obsolete sysctl(2) system
call, or used the term "sysctls"; rewrite these mentions to
instead be in terms of /proc interfaces.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2008-11-20 20:37:11 +00:00
|
|
|
parameter
|
2008-08-08 16:41:48 +00:00
|
|
|
is enabled (but still passed to the user even when it is turned off).
|
|
|
|
See
|
|
|
|
.BR ip (7).
|
|
|
|
|
|
|
|
When the
|
|
|
|
.B MSG_DONTROUTE
|
2008-11-21 22:38:34 +00:00
|
|
|
flag is set on sending, the destination address must refer to a local
|
2008-08-08 16:41:48 +00:00
|
|
|
interface address and the packet is only sent to that interface.
|
|
|
|
|
2008-11-21 22:38:34 +00:00
|
|
|
By default, Linux UDP does path MTU (Maximum Transmission Unit) discovery.
|
2008-08-08 16:41:48 +00:00
|
|
|
This means the kernel
|
|
|
|
will keep track of the MTU to a specific target IP address and return
|
|
|
|
.B EMSGSIZE
|
|
|
|
when a UDP packet write exceeds it.
|
2008-11-21 22:43:46 +00:00
|
|
|
When this happens, the application should decrease the packet size.
|
2008-08-08 16:41:48 +00:00
|
|
|
Path MTU discovery can be also turned off using the
|
|
|
|
.B IP_MTU_DISCOVER
|
|
|
|
socket option or the
|
connect.2, listen.2, send.2, uname.2, cmsg.3, proc.5, arp.7, ddp.7, icmp.7, ip.7, raw.7, socket.7, tcp.7, udp.7: Global fix: eliminate mention of the obsolete sysctl(2) interface
Many pages still mention use of the obsolete sysctl(2) system
call, or used the term "sysctls"; rewrite these mentions to
instead be in terms of /proc interfaces.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2008-11-20 20:37:11 +00:00
|
|
|
.I /proc/sys/net/ipv4/ip_no_pmtu_disc
|
|
|
|
file; see
|
2008-08-08 16:41:48 +00:00
|
|
|
.BR ip (7)
|
|
|
|
for details.
|
2008-11-21 22:43:46 +00:00
|
|
|
When turned off, UDP will fragment outgoing UDP packets
|
2008-08-08 16:41:48 +00:00
|
|
|
that exceed the interface MTU.
|
2008-11-21 22:43:46 +00:00
|
|
|
However, disabling it is not recommended
|
2008-08-08 16:41:48 +00:00
|
|
|
for performance and reliability reasons.
|
intro.1, time.1, _syscall.2, accept.2, brk.2, capget.2, faccessat.2, futimesat.2, gethostname.2, intro.2, ioprio_set.2, kill.2, madvise.2, mlock.2, mount.2, msgget.2, perf_event_open.2, poll.2, readv.2, sched_rr_get_interval.2, sched_setscheduler.2, select.2, select_tut.2, shmget.2, stat.2, timer_create.2, ustat.2, vfork.2, wait.2, alloca.3, atexit.3, catopen.3, crypt.3, dbopen.3, fenv.3, fopen.3, getaddrinfo_a.3, gethostbyname.3, getutent.3, intro.3, login.3, mallopt.3, queue.3, regex.3, sigpause.3, sigsetops.3, stdio.3, strftime.3, strptime.3, sysconf.3, ttyslot.3, undocumented.3, cciss.4, console_codes.4, hpsa.4, initrd.4, intro.4, rtc.4, st.4, tty_ioctl.4, wavelan.4, acct.5, charmap.5, dir_colors.5, hosts.5, intro.5, termcap.5, utmp.5, intro.6, armscii-8.7, boot.7, bootparam.7, capabilities.7, cpuset.7, credentials.7, ddp.7, epoll.7, glob.7, intro.7, ip.7, ipv6.7, iso_8859-1.7, iso_8859-10.7, iso_8859-11.7, iso_8859-13.7, iso_8859-14.7, iso_8859-15.7, iso_8859-16.7, iso_8859-2.7, iso_8859-3.7, iso_8859-4.7, iso_8859-5.7, iso_8859-6.7, iso_8859-7.7, iso_8859-8.7, iso_8859-9.7, koi8-r.7, koi8-u.7, man-pages.7, man.7, math_error.7, netlink.7, numa.7, packet.7, path_resolution.7, pipe.7, pthreads.7, raw.7, rtnetlink.7, signal.7, socket.7, spufs.7, svipc.7, tcp.7, time.7, udp.7, udplite.7, unicode.7, unix.7, uri.7, utf-8.7, x25.7, intro.8: Global fix: use consistent capitalization in .SS headings
Capitalization in .SS sections across pages (and sometimes even
within a single page) is wildly inconsistent. Make it consistent.
Capitalize first word in heading, but otherwise use lower case,
except where English usage (e.g., proper nouns) or programming
language requirements (e.g., identifier names) dictate otherwise.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-02-24 14:08:38 +00:00
|
|
|
.SS "Address format"
|
2008-08-08 16:41:48 +00:00
|
|
|
UDP uses the IPv4
|
|
|
|
.I sockaddr_in
|
|
|
|
address format described in
|
|
|
|
.BR ip (7).
|
intro.1, time.1, _syscall.2, accept.2, brk.2, capget.2, faccessat.2, futimesat.2, gethostname.2, intro.2, ioprio_set.2, kill.2, madvise.2, mlock.2, mount.2, msgget.2, perf_event_open.2, poll.2, readv.2, sched_rr_get_interval.2, sched_setscheduler.2, select.2, select_tut.2, shmget.2, stat.2, timer_create.2, ustat.2, vfork.2, wait.2, alloca.3, atexit.3, catopen.3, crypt.3, dbopen.3, fenv.3, fopen.3, getaddrinfo_a.3, gethostbyname.3, getutent.3, intro.3, login.3, mallopt.3, queue.3, regex.3, sigpause.3, sigsetops.3, stdio.3, strftime.3, strptime.3, sysconf.3, ttyslot.3, undocumented.3, cciss.4, console_codes.4, hpsa.4, initrd.4, intro.4, rtc.4, st.4, tty_ioctl.4, wavelan.4, acct.5, charmap.5, dir_colors.5, hosts.5, intro.5, termcap.5, utmp.5, intro.6, armscii-8.7, boot.7, bootparam.7, capabilities.7, cpuset.7, credentials.7, ddp.7, epoll.7, glob.7, intro.7, ip.7, ipv6.7, iso_8859-1.7, iso_8859-10.7, iso_8859-11.7, iso_8859-13.7, iso_8859-14.7, iso_8859-15.7, iso_8859-16.7, iso_8859-2.7, iso_8859-3.7, iso_8859-4.7, iso_8859-5.7, iso_8859-6.7, iso_8859-7.7, iso_8859-8.7, iso_8859-9.7, koi8-r.7, koi8-u.7, man-pages.7, man.7, math_error.7, netlink.7, numa.7, packet.7, path_resolution.7, pipe.7, pthreads.7, raw.7, rtnetlink.7, signal.7, socket.7, spufs.7, svipc.7, tcp.7, time.7, udp.7, udplite.7, unicode.7, unix.7, uri.7, utf-8.7, x25.7, intro.8: Global fix: use consistent capitalization in .SS headings
Capitalization in .SS sections across pages (and sometimes even
within a single page) is wildly inconsistent. Make it consistent.
Capitalize first word in heading, but otherwise use lower case,
except where English usage (e.g., proper nouns) or programming
language requirements (e.g., identifier names) dictate otherwise.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-02-24 14:08:38 +00:00
|
|
|
.SS "Error handling"
|
2008-08-08 16:41:48 +00:00
|
|
|
All fatal errors will be passed to the user as an error return even
|
|
|
|
when the socket is not connected.
|
|
|
|
This includes asynchronous errors
|
|
|
|
received from the network.
|
|
|
|
You may get an error for an earlier packet
|
|
|
|
that was sent on the same socket.
|
|
|
|
This behavior differs from many other BSD socket implementations
|
|
|
|
which don't pass any errors unless the socket is connected.
|
|
|
|
Linux's behavior is mandated by
|
|
|
|
.BR RFC\ 1122 .
|
|
|
|
|
2008-11-21 22:43:46 +00:00
|
|
|
For compatibility with legacy code, in Linux 2.0 and 2.2
|
2008-08-08 16:41:48 +00:00
|
|
|
it was possible to set the
|
|
|
|
.B SO_BSDCOMPAT
|
|
|
|
.B SOL_SOCKET
|
|
|
|
option to receive remote errors only when the socket has been
|
|
|
|
connected (except for
|
|
|
|
.B EPROTO
|
|
|
|
and
|
|
|
|
.BR EMSGSIZE ).
|
|
|
|
Locally generated errors are always passed.
|
|
|
|
Support for this socket option was removed in later kernels; see
|
|
|
|
.BR socket (7)
|
|
|
|
for further information.
|
|
|
|
|
|
|
|
When the
|
|
|
|
.B IP_RECVERR
|
2008-11-21 22:43:46 +00:00
|
|
|
option is enabled, all errors are stored in the socket error queue,
|
2008-08-08 16:41:48 +00:00
|
|
|
and can be received by
|
|
|
|
.BR recvmsg (2)
|
|
|
|
with the
|
|
|
|
.B MSG_ERRQUEUE
|
|
|
|
flag set.
|
2008-11-21 23:02:06 +00:00
|
|
|
.SS /proc interfaces
|
|
|
|
System-wide UDP parameter settings can be accessed by files in the directory
|
|
|
|
.IR /proc/sys/net/ipv4/ .
|
|
|
|
.TP
|
|
|
|
.IR udp_mem " (since Linux 2.6.25)"
|
|
|
|
This is a vector of three integers governing the number
|
|
|
|
of pages allowed for queueing by all UDP sockets.
|
|
|
|
.RS
|
|
|
|
.TP 10
|
|
|
|
.I min
|
|
|
|
Below this number of pages, UDP is not bothered about its
|
|
|
|
memory appetite.
|
|
|
|
When the amount of memory allocated by UDP exceeds
|
|
|
|
this number, UDP starts to moderate memory usage.
|
|
|
|
.TP
|
|
|
|
.I pressure
|
|
|
|
This value was introduced to follow the format of
|
2008-11-26 02:44:53 +00:00
|
|
|
.IR tcp_mem
|
2008-11-21 23:02:06 +00:00
|
|
|
(see
|
|
|
|
.BR tcp (7)).
|
|
|
|
.TP
|
|
|
|
.I max
|
|
|
|
Number of pages allowed for queueing by all UDP sockets.
|
|
|
|
.RE
|
|
|
|
.IP
|
|
|
|
Defaults values for these three items are
|
|
|
|
calculated at boot time from the amount of available memory.
|
|
|
|
.TP
|
|
|
|
.IR udp_rmem_min " (integer; default value: PAGE_SIZE; since Linux 2.6.25)"
|
2009-09-27 07:26:40 +00:00
|
|
|
Minimal size, in bytes, of receive buffers used by UDP sockets in moderation.
|
2008-11-21 23:02:06 +00:00
|
|
|
Each UDP socket is able to use the size for receiving data,
|
2009-09-27 07:26:40 +00:00
|
|
|
even if total pages of UDP sockets exceed
|
|
|
|
.I udp_mem
|
|
|
|
pressure.
|
2008-11-21 23:02:06 +00:00
|
|
|
.TP
|
|
|
|
.IR udp_wmem_min " (integer; default value: PAGE_SIZE; since Linux 2.6.25)"
|
|
|
|
Minimal size, in bytes, of send buffer used by UDP sockets in moderation.
|
|
|
|
Each UDP socket is able to use the size for sending data,
|
|
|
|
even if total pages of UDP sockets exceed
|
|
|
|
.I udp_mem
|
|
|
|
pressure.
|
intro.1, time.1, _syscall.2, accept.2, brk.2, capget.2, faccessat.2, futimesat.2, gethostname.2, intro.2, ioprio_set.2, kill.2, madvise.2, mlock.2, mount.2, msgget.2, perf_event_open.2, poll.2, readv.2, sched_rr_get_interval.2, sched_setscheduler.2, select.2, select_tut.2, shmget.2, stat.2, timer_create.2, ustat.2, vfork.2, wait.2, alloca.3, atexit.3, catopen.3, crypt.3, dbopen.3, fenv.3, fopen.3, getaddrinfo_a.3, gethostbyname.3, getutent.3, intro.3, login.3, mallopt.3, queue.3, regex.3, sigpause.3, sigsetops.3, stdio.3, strftime.3, strptime.3, sysconf.3, ttyslot.3, undocumented.3, cciss.4, console_codes.4, hpsa.4, initrd.4, intro.4, rtc.4, st.4, tty_ioctl.4, wavelan.4, acct.5, charmap.5, dir_colors.5, hosts.5, intro.5, termcap.5, utmp.5, intro.6, armscii-8.7, boot.7, bootparam.7, capabilities.7, cpuset.7, credentials.7, ddp.7, epoll.7, glob.7, intro.7, ip.7, ipv6.7, iso_8859-1.7, iso_8859-10.7, iso_8859-11.7, iso_8859-13.7, iso_8859-14.7, iso_8859-15.7, iso_8859-16.7, iso_8859-2.7, iso_8859-3.7, iso_8859-4.7, iso_8859-5.7, iso_8859-6.7, iso_8859-7.7, iso_8859-8.7, iso_8859-9.7, koi8-r.7, koi8-u.7, man-pages.7, man.7, math_error.7, netlink.7, numa.7, packet.7, path_resolution.7, pipe.7, pthreads.7, raw.7, rtnetlink.7, signal.7, socket.7, spufs.7, svipc.7, tcp.7, time.7, udp.7, udplite.7, unicode.7, unix.7, uri.7, utf-8.7, x25.7, intro.8: Global fix: use consistent capitalization in .SS headings
Capitalization in .SS sections across pages (and sometimes even
within a single page) is wildly inconsistent. Make it consistent.
Capitalize first word in heading, but otherwise use lower case,
except where English usage (e.g., proper nouns) or programming
language requirements (e.g., identifier names) dictate otherwise.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-02-24 14:08:38 +00:00
|
|
|
.SS "Socket options"
|
2008-08-08 16:41:48 +00:00
|
|
|
To set or get a UDP socket option, call
|
|
|
|
.BR getsockopt (2)
|
|
|
|
to read or
|
|
|
|
.BR setsockopt (2)
|
|
|
|
to write the option with the option level argument set to
|
|
|
|
.BR IPPROTO_UDP .
|
|
|
|
.TP
|
|
|
|
.BR UDP_CORK " (since Linux 2.5.44)"
|
|
|
|
If this option is enabled, then all data output on this socket
|
|
|
|
is accumulated into a single datagram that is transmitted when
|
|
|
|
the option is disabled.
|
|
|
|
This option should not be used in code intended to be
|
|
|
|
portable.
|
|
|
|
.\" FIXME document UDP_ENCAP (new in kernel 2.5.67)
|
2008-11-21 22:33:24 +00:00
|
|
|
.\" From include/linux/udp.h:
|
|
|
|
.\" /* UDP encapsulation types */
|
|
|
|
.\" #define UDP_ENCAP_ESPINUDP_NON_IKE 1 /* draft-ietf-ipsec-nat-t-ike-00/01 */
|
|
|
|
.\" #define UDP_ENCAP_ESPINUDP 2 /* draft-ietf-ipsec-udp-encaps-06 */
|
|
|
|
.\" #define UDP_ENCAP_L2TPINUDP 3 /* rfc2661 */
|
2008-08-08 16:41:48 +00:00
|
|
|
.SS Ioctls
|
|
|
|
These ioctls can be accessed using
|
|
|
|
.BR ioctl (2).
|
|
|
|
The correct syntax is:
|
|
|
|
.PP
|
|
|
|
.RS
|
|
|
|
.nf
|
|
|
|
.BI int " value";
|
|
|
|
.IB error " = ioctl(" udp_socket ", " ioctl_type ", &" value ");"
|
|
|
|
.fi
|
|
|
|
.RE
|
|
|
|
.TP
|
|
|
|
.BR FIONREAD " (" SIOCINQ )
|
|
|
|
Gets a pointer to an integer as argument.
|
|
|
|
Returns the size of the next pending datagram in the integer in bytes,
|
|
|
|
or 0 when no datagram is pending.
|
2010-06-13 03:00:58 +00:00
|
|
|
.B Warning:
|
|
|
|
Using
|
|
|
|
.BR FIONREAD ,
|
|
|
|
it is impossible to distinguish the case where no datagram is pending
|
|
|
|
from the case where the next pending datagram contains zero bytes of data.
|
|
|
|
It is safer to use
|
|
|
|
.BR select (2),
|
|
|
|
.BR poll (2),
|
|
|
|
or
|
|
|
|
.BR epoll (7)
|
|
|
|
to distinguish these cases.
|
|
|
|
.\" See http://www.securiteam.com/unixfocus/5KP0I15IKO.html
|
|
|
|
.\" "GNUnet DoS (UDP Socket Unreachable)", 14 May 2006
|
2008-08-08 16:41:48 +00:00
|
|
|
.TP
|
|
|
|
.BR TIOCOUTQ " (" SIOCOUTQ )
|
|
|
|
Returns the number of data bytes in the local send queue.
|
|
|
|
Only supported with Linux 2.4 and above.
|
|
|
|
.PP
|
|
|
|
In addition all ioctls documented in
|
|
|
|
.BR ip (7)
|
|
|
|
and
|
|
|
|
.BR socket (7)
|
|
|
|
are supported.
|
|
|
|
.SH ERRORS
|
|
|
|
All errors documented for
|
|
|
|
.BR socket (7)
|
|
|
|
or
|
|
|
|
.BR ip (7)
|
|
|
|
may be returned by a send or receive on a UDP socket.
|
2008-12-01 15:21:23 +00:00
|
|
|
.TP
|
2008-08-08 16:41:48 +00:00
|
|
|
.B ECONNREFUSED
|
|
|
|
No receiver was associated with the destination address.
|
|
|
|
This might be caused by a previous packet sent over the socket.
|
|
|
|
.SH VERSIONS
|
2008-11-21 22:36:31 +00:00
|
|
|
.B IP_RECVERR
|
|
|
|
is a new feature in Linux 2.2.
|
2008-08-08 16:41:48 +00:00
|
|
|
.\" .SH CREDITS
|
|
|
|
.\" This man page was written by Andi Kleen.
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR ip (7),
|
|
|
|
.BR raw (7),
|
2008-08-08 16:50:10 +00:00
|
|
|
.BR socket (7),
|
|
|
|
.BR udplite (7)
|
2008-08-08 16:41:48 +00:00
|
|
|
|
|
|
|
RFC\ 768 for the User Datagram Protocol.
|
|
|
|
.br
|
|
|
|
RFC\ 1122 for the host requirements.
|
|
|
|
.br
|
|
|
|
RFC\ 1191 for a description of path MTU discovery.
|