man2/bind.2

   1 .\" Copyright 1993 Rickard E. Faith (faith@cs.unc.edu)
   2 .\" Portions extracted from /usr/include/sys/socket.h, which does not have
   3 .\" any authorship information in it.  It is probably available under the GPL.
   4 .\"
   5 .\" %%%LICENSE_START(VERBATIM)
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\" %%%LICENSE_END
  26 .\"
  27 .\"
  28 .\" Other portions are from the 6.9 (Berkeley) 3/10/91 man page:
  29 .\"
  30 .\" Copyright (c) 1983 The Regents of the University of California.
  31 .\" All rights reserved.
  32 .\"
  33 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
  34 .\" Redistribution and use in source and binary forms, with or without
  35 .\" modification, are permitted provided that the following conditions
  36 .\" are met:
  37 .\" 1. Redistributions of source code must retain the above copyright
  38 .\"    notice, this list of conditions and the following disclaimer.
  39 .\" 2. Redistributions in binary form must reproduce the above copyright
  40 .\"    notice, this list of conditions and the following disclaimer in the
  41 .\"    documentation and/or other materials provided with the distribution.
  42 .\" 3. All advertising materials mentioning features or use of this software
  43 .\"    must display the following acknowledgement:
  44 .\"     This product includes software developed by the University of
  45 .\"     California, Berkeley and its contributors.
  46 .\" 4. Neither the name of the University nor the names of its contributors
  47 .\"    may be used to endorse or promote products derived from this software
  48 .\"    without specific prior written permission.
  49 .\"
  50 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  51 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  52 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  53 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  54 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  55 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  56 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  57 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  58 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  59 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  60 .\" SUCH DAMAGE.
  61 .\" %%%LICENSE_END
  62 .\"
  63 .\" Modified Mon Oct 21 23:05:29 EDT 1996 by Eric S. Raymond <esr@thyrsus.com>
  64 .\" Modified 1998 by Andi Kleen
  65 .\" $Id: bind.2,v 1.3 1999/04/23 19:56:07 freitag Exp $
  66 .\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com>
  67 .\"
  68 .TH BIND 2 2019-03-06 "Linux" "Linux Programmer's Manual"
  69 .SH NAME
  70 bind \- bind a name to a socket
  71 .SH SYNOPSIS
  72 .nf
  73 .BR "#include <sys/types.h>" "          /* See NOTES */"
  74 .B #include <sys/socket.h>
  75 .PP
  76 .BI "int bind(int " sockfd ", const struct sockaddr *" addr ,
  77 .BI "         socklen_t " addrlen );
  78 .fi
  79 .SH DESCRIPTION
  80 When a socket is created with
  81 .BR socket (2),
  82 it exists in a name space (address family) but has no address assigned to it.
  83 .BR bind ()
  84 assigns the address specified by
  85 .I addr
  86 to the socket referred to by the file descriptor
  87 .IR sockfd .
  88 .I addrlen
  89 specifies the size, in bytes, of the address structure pointed to by
  90 .IR addr .
  91 Traditionally, this operation is called \(lqassigning a name to a socket\(rq.
  92 .PP
  93 It is normally necessary to assign a local address using
  94 .BR bind ()
  95 before a
  96 .B SOCK_STREAM
  97 socket may receive connections (see
  98 .BR accept (2)).
  99 .PP
 100 The rules used in name binding vary between address families.
 101 Consult the manual entries in Section 7 for detailed information.
 102 For
 103 .BR AF_INET ,
 104 see
 105 .BR ip (7);
 106 for
 107 .BR AF_INET6 ,
 108 see
 109 .BR ipv6 (7);
 110 for
 111 .BR AF_UNIX ,
 112 see
 113 .BR unix (7);
 114 for
 115 .BR AF_APPLETALK ,
 116 see
 117 .BR ddp (7);
 118 for
 119 .BR AF_PACKET ,
 120 see
 121 .BR packet (7);
 122 for
 123 .BR AF_X25 ,
 124 see
 125 .BR x25 (7);
 126 and for
 127 .BR AF_NETLINK ,
 128 see
 129 .BR netlink (7).
 130 .PP
 131 The actual structure passed for the
 132 .I addr
 133 argument will depend on the address family.
 134 The
 135 .I sockaddr
 136 structure is defined as something like:
 137 .PP
 138 .in +4n
 139 .EX
 140 struct sockaddr {
 141     sa_family_t sa_family;
 142     char        sa_data[14];
 143 }
 144 .EE
 145 .in
 146 .PP
 147 The only purpose of this structure is to cast the structure
 148 pointer passed in
 149 .I addr
 150 in order to avoid compiler warnings.
 151 See EXAMPLE below.
 152 .SH RETURN VALUE
 153 On success, zero is returned.
 154 On error, \-1 is returned, and
 155 .I errno
 156 is set appropriately.
 157 .SH ERRORS
 158 .TP
 159 .B EACCES
 160 .\" e.g., privileged port in AF_INET domain
 161 The address is protected, and the user is not the superuser.
 162 .TP
 163 .B EADDRINUSE
 164 The given address is already in use.
 165 .TP
 166 .B EADDRINUSE
 167 (Internet domain sockets)
 168 The port number was specified as zero in the socket address structure,
 169 but, upon attempting to bind to an ephemeral port,
 170 it was determined that all port numbers in the ephemeral port range
 171 are currently in use.
 172 See the discussion of
 173 .I /proc/sys/net/ipv4/ip_local_port_range
 174 .BR ip (7).
 175 .TP
 176 .B EBADF
 177 .I sockfd
 178 is not a valid file descriptor.
 179 .TP
 180 .B EINVAL
 181 The socket is already bound to an address.
 182 .\" This may change in the future: see
 183 .\" .I linux/unix/sock.c for details.
 184 .TP
 185 .B EINVAL
 186 .I addrlen
 187 is wrong, or
 188 .I addr
 189 is not a valid address for this socket's domain.
 190 .TP
 191 .B ENOTSOCK
 192 The file descriptor
 193 .I sockfd
 194 does not refer to a socket.
 195 .PP
 196 The following errors are specific to UNIX domain
 197 .RB ( AF_UNIX )
 198 sockets:
 199 .TP
 200 .B EACCES
 201 Search permission is denied on a component of the path prefix.
 202 (See also
 203 .BR path_resolution (7).)
 204 .TP
 205 .B EADDRNOTAVAIL
 206 A nonexistent interface was requested or the requested
 207 address was not local.
 208 .TP
 209 .B EFAULT
 210 .I addr
 211 points outside the user's accessible address space.
 212 .TP
 213 .B ELOOP
 214 Too many symbolic links were encountered in resolving
 215 .IR addr .
 216 .TP
 217 .B ENAMETOOLONG
 218 .I addr
 219 is too long.
 220 .TP
 221 .B ENOENT
 222 A component in the directory prefix of the socket pathname does not exist.
 223 .TP
 224 .B ENOMEM
 225 Insufficient kernel memory was available.
 226 .TP
 227 .B ENOTDIR
 228 A component of the path prefix is not a directory.
 229 .TP
 230 .B EROFS
 231 The socket inode would reside on a read-only filesystem.
 232 .SH CONFORMING TO
 233 POSIX.1-2001, POSIX.1-2008, SVr4, 4.4BSD
 234 .RB ( bind ()
 235 first appeared in 4.2BSD).
 236 .\" SVr4 documents an additional
 237 .\" .B ENOSR
 238 .\" general error condition, and
 239 .\" additional
 240 .\" .B EIO
 241 .\" and
 242 .\" .B EISDIR
 243 .\" UNIX-domain error conditions.
 244 .SH NOTES
 245 POSIX.1 does not require the inclusion of
 246 .IR <sys/types.h> ,
 247 and this header file is not required on Linux.
 248 However, some historical (BSD) implementations required this header
 249 file, and portable applications are probably wise to include it.
 250 .PP
 251 For background on the
 252 .I socklen_t
 253 type, see
 254 .BR accept (2).
 255 .SH BUGS
 256 The transparent proxy options are not described.
 257 .\" FIXME Document transparent proxy options
 258 .SH EXAMPLE
 259 An example of the use of
 260 .BR bind ()
 261 with Internet domain sockets can be found in
 262 .BR getaddrinfo (3).
 263 .PP
 264 The following example shows how to bind a stream socket in the UNIX
 265 .RB ( AF_UNIX )
 266 domain, and accept connections:
 267 .\" listen.7 refers to this example.
 268 .\" accept.7 refers to this example.
 269 .\" unix.7 refers to this example.
 270 .PP
 271 .EX
 272 #include <sys/socket.h>
 273 #include <sys/un.h>
 274 #include <stdlib.h>
 275 #include <stdio.h>
 276 #include <string.h>
 277
 278 #define MY_SOCK_PATH "/somepath"
 279 #define LISTEN_BACKLOG 50
 280
 281 #define handle_error(msg) \e
 282     do { perror(msg); exit(EXIT_FAILURE); } while (0)
 283
 284 int
 285 main(int argc, char *argv[])
 286 {
 287     int sfd, cfd;
 288     struct sockaddr_un my_addr, peer_addr;
 289     socklen_t peer_addr_size;
 290
 291     sfd = socket(AF_UNIX, SOCK_STREAM, 0);
 292     if (sfd == \-1)
 293         handle_error("socket");
 294
 295     memset(&my_addr, 0, sizeof(struct sockaddr_un));
 296                         /* Clear structure */
 297     my_addr.sun_family = AF_UNIX;
 298     strncpy(my_addr.sun_path, MY_SOCK_PATH,
 299             sizeof(my_addr.sun_path) \- 1);
 300
 301     if (bind(sfd, (struct sockaddr *) &my_addr,
 302             sizeof(struct sockaddr_un)) == \-1)
 303         handle_error("bind");
 304
 305     if (listen(sfd, LISTEN_BACKLOG) == \-1)
 306         handle_error("listen");
 307
 308     /* Now we can accept incoming connections one
 309        at a time using accept(2) */
 310
 311     peer_addr_size = sizeof(struct sockaddr_un);
 312     cfd = accept(sfd, (struct sockaddr *) &peer_addr,
 313                  &peer_addr_size);
 314     if (cfd == \-1)
 315         handle_error("accept");
 316
 317     /* Code to deal with incoming connection(s)... */
 318
 319     /* When no longer required, the socket pathname, MY_SOCK_PATH
 320        should be deleted using unlink(2) or remove(3) */
 321 }
 322 .EE
 323 .SH SEE ALSO
 324 .BR accept (2),
 325 .BR connect (2),
 326 .BR getsockname (2),
 327 .BR listen (2),
 328 .BR socket (2),
 329 .BR getaddrinfo (3),
 330 .BR getifaddrs (3),
 331 .BR ip (7),
 332 .BR ipv6 (7),
 333 .BR path_resolution (7),
 334 .BR socket (7),
 335 .BR unix (7)