Blame man3/bindresvport.3

Packit 7cfc04
.\" Copyright (C) 2007, Michael Kerrisk <mtk.manpages@gmail.com>
Packit 7cfc04
.\" and Copyright (C) 2008, Linux Foundation, written by Michael Kerrisk
Packit 7cfc04
.\"     <mtk.manpages@gmail.com>
Packit 7cfc04
.\"
Packit 7cfc04
.\" %%%LICENSE_START(VERBATIM)
Packit 7cfc04
.\" Permission is granted to make and distribute verbatim copies of this
Packit 7cfc04
.\" manual provided the copyright notice and this permission notice are
Packit 7cfc04
.\" preserved on all copies.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Permission is granted to copy and distribute modified versions of this
Packit 7cfc04
.\" manual under the conditions for verbatim copying, provided that the
Packit 7cfc04
.\" entire resulting derived work is distributed under the terms of a
Packit 7cfc04
.\" permission notice identical to this one.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Since the Linux kernel and libraries are constantly changing, this
Packit 7cfc04
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
Packit 7cfc04
.\" responsibility for errors or omissions, or for damages resulting from
Packit 7cfc04
.\" the use of the information contained herein.  The author(s) may not
Packit 7cfc04
.\" have taken the same level of care in the production of this manual,
Packit 7cfc04
.\" which is licensed free of charge, as they might when working
Packit 7cfc04
.\" professionally.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Formatted or processed versions of this manual, if unaccompanied by
Packit 7cfc04
.\" the source, must acknowledge the copyright and authors of this work.
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.\" 2007-05-31, mtk: Rewrite and substantial additional text.
Packit 7cfc04
.\" 2008-12-03, mtk: Rewrote some pieces and fixed some errors
Packit 7cfc04
.\"
Packit 7cfc04
.TH BINDRESVPORT 3  2017-09-15 "" "Linux Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
bindresvport \- bind a socket to a privileged IP port
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.nf
Packit 7cfc04
.B #include <sys/types.h>
Packit 7cfc04
.B #include <netinet/in.h>
Packit 7cfc04
.PP
Packit 7cfc04
.BI "int bindresvport(int " sockfd ", struct sockaddr_in *" sin );
Packit 7cfc04
.fi
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
.PP
Packit 7cfc04
.BR bindresvport ()
Packit 7cfc04
is used to bind the socket referred to by the
Packit 7cfc04
file descriptor
Packit 7cfc04
.I sockfd
Packit 7cfc04
to a privileged anonymous IP port,
Packit 7cfc04
that is, a port number arbitrarily selected from the range 512 to 1023.
Packit 7cfc04
.\" Glibc actually starts searching with a port # in the range 600 to 1023
Packit 7cfc04
.PP
Packit 7cfc04
If the
Packit 7cfc04
.BR bind (2)
Packit 7cfc04
performed by
Packit 7cfc04
.BR bindresvport ()
Packit 7cfc04
is successful, and
Packit 7cfc04
.I sin
Packit 7cfc04
is not NULL, then
Packit 7cfc04
.I sin\->sin_port
Packit 7cfc04
returns the port number actually allocated.
Packit 7cfc04
.PP
Packit 7cfc04
.I sin
Packit 7cfc04
can be NULL, in which case
Packit 7cfc04
.I sin\->sin_family
Packit 7cfc04
is implicitly taken to be
Packit 7cfc04
.BR AF_INET .
Packit 7cfc04
However, in this case,
Packit 7cfc04
.BR bindresvport ()
Packit 7cfc04
has no way to return the port number actually allocated.
Packit 7cfc04
(This information can later be obtained using
Packit 7cfc04
.BR getsockname (2).)
Packit 7cfc04
.SH RETURN VALUE
Packit 7cfc04
.BR bindresvport ()
Packit 7cfc04
returns 0 on success; otherwise \-1 is returned and
Packit 7cfc04
.I errno
Packit 7cfc04
set to indicate the cause of the error.
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
.BR bindresvport ()
Packit 7cfc04
can fail for any of the same reasons as
Packit 7cfc04
.BR bind (2).
Packit 7cfc04
In addition, the following errors may occur:
Packit 7cfc04
.TP
Packit 7cfc04
.BR EACCES
Packit 7cfc04
The calling process was not privileged
Packit 7cfc04
(on Linux: the calling process did not have the
Packit 7cfc04
.B CAP_NET_BIND_SERVICE
Packit 7cfc04
capability in the user namespace governing its network namespace).
Packit 7cfc04
.TP
Packit 7cfc04
.B EADDRINUSE
Packit 7cfc04
All privileged ports are in use.
Packit 7cfc04
.TP
Packit 7cfc04
.BR EAFNOSUPPORT " (" EPFNOSUPPORT " in glibc 2.7 and earlier)"
Packit 7cfc04
.I sin
Packit 7cfc04
is not NULL and
Packit 7cfc04
.I sin->sin_family
Packit 7cfc04
is not
Packit 7cfc04
.BR AF_INET .
Packit 7cfc04
.SH ATTRIBUTES
Packit 7cfc04
For an explanation of the terms used in this section, see
Packit 7cfc04
.BR attributes (7).
Packit 7cfc04
.TS
Packit 7cfc04
allbox;
Packit 7cfc04
lb lb lb
Packit 7cfc04
l l lw23.
Packit 7cfc04
Interface	Attribute	Value
Packit 7cfc04
T{
Packit 7cfc04
.BR bindresvport ()
Packit 7cfc04
T}	Thread safety	T{
Packit 7cfc04
glibc >= 2.17: MT-Safe
Packit 7cfc04
.\" commit f6da27e53695ad1cc0e2a9490358decbbfdff5e5
Packit 7cfc04
.br
Packit 7cfc04
glibc < 2.17: MT-Unsafe
Packit 7cfc04
T}
Packit 7cfc04
.TE
Packit 7cfc04
.PP
Packit 7cfc04
The
Packit 7cfc04
.BR bindresvport ()
Packit 7cfc04
function uses a static variable that was not protected by a lock
Packit 7cfc04
before glibc 2.17, rendering the function MT-Unsafe.
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
Not in POSIX.1.
Packit 7cfc04
Present on the BSDs, Solaris, and many other systems.
Packit 7cfc04
.SH NOTES
Packit 7cfc04
Unlike some
Packit 7cfc04
.BR bindresvport ()
Packit 7cfc04
implementations,
Packit 7cfc04
the glibc implementation ignores any value that the caller supplies in
Packit 7cfc04
.IR sin\->sin_port .
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR bind (2),
Packit 7cfc04
.BR getsockname (2)
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.