1.\" Copyright (c) 1983, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)bind.2 8.1 (Berkeley) 6/4/93 33.\" $FreeBSD$ 34.\" 35.Dd June 4, 1993 36.Dt BIND 2 37.Os 38.Sh NAME 39.Nm bind 40.Nd assign a local protocol address to a socket 41.Sh LIBRARY 42.Lb libc 43.Sh SYNOPSIS 44.Fd #include <sys/types.h> 45.Fd #include <sys/socket.h> 46.Ft int 47.Fn bind "int s" "const struct sockaddr *addr" "socklen_t addrlen" 48.Sh DESCRIPTION 49.Fn Bind 50assigns the local protocol address to a socket. 51When a socket is created 52with 53.Xr socket 2 54it exists in an address family space but has no protocol address assigned. 55.Fn Bind 56requests that 57.Fa addr 58be assigned to the socket. 59.Sh NOTES 60Binding an address in the UNIX domain creates a socket in the file 61system that must be deleted by the caller when it is no longer 62needed (using 63.Xr unlink 2 ) . 64.Pp 65The rules used in address binding vary between communication domains. 66Consult the manual entries in section 4 for detailed information. 67.Sh IMPLEMENTATION NOTES 68In the non-threaded library 69.Fn bind 70is implemented as the 71.Va bind 72syscall. 73.Pp 74In the threaded library, the 75.Va bind 76syscall is assembled to 77.Fn _thread_sys_bind 78and 79.Fn bind 80is implemented as a function which locks 81.Fa s 82for read and write, then calls 83.Fn _thread_sys_bind . 84Before returning, 85.Fn bind 86unlocks 87.Fa s . 88.Sh RETURN VALUES 89If the bind is successful, a 0 value is returned. 90A return value of -1 indicates an error, which is 91further specified in the global 92.Va errno . 93.Sh ERRORS 94The 95.Fn bind 96call will fail if: 97.Bl -tag -width Er 98.It Bq Er EAGAIN 99Kernel resources to complete the request are 100temporarily unavilable. 101.It Bq Er EBADF 102.Fa S 103is not a valid descriptor. 104.It Bq Er ENOTSOCK 105.Fa S 106is not a socket. 107.It Bq Er EADDRNOTAVAIL 108The specified address is not available from the local machine. 109.It Bq Er EADDRINUSE 110The specified address is already in use. 111.It Bq Er EACCES 112The requested address is protected, and the current user 113has inadequate permission to access it. 114.It Bq Er EFAULT 115The 116.Fa addr 117parameter is not in a valid part of the user 118address space. 119.El 120.Pp 121The following errors are specific to binding addresses in the UNIX domain. 122.Bl -tag -width EADDRNOTAVA 123.It Bq Er ENOTDIR 124A component of the path prefix is not a directory. 125.It Bq Er ENAMETOOLONG 126A component of a pathname exceeded 255 characters, 127or an entire path name exceeded 1023 characters. 128.It Bq Er ENOENT 129A prefix component of the path name does not exist. 130.It Bq Er ELOOP 131Too many symbolic links were encountered in translating the pathname. 132.It Bq Er EIO 133An I/O error occurred while making the directory entry or allocating the inode. 134.It Bq Er EROFS 135The name would reside on a read-only file system. 136.It Bq Er EISDIR 137An empty pathname was specified. 138.El 139.Sh SEE ALSO 140.Xr connect 2 , 141.Xr getsockname 2 , 142.Xr listen 2 , 143.Xr socket 2 144.Sh HISTORY 145The 146.Fn bind 147function call appeared in 148.Bx 4.2 . 149