release/man2/bind.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" Copyright 1993 Rickard E. Faith (faith@cs.unc.edu)
   4 .\" Portions extracted from /usr/include/sys/socket.h, which does not have
   5 .\" any authorship information in it.  It is probably available under the GPL.
   6 .\"
   7 .\" Permission is granted to make and distribute verbatim copies of this
   8 .\" manual provided the copyright notice and this permission notice are
   9 .\" preserved on all copies.
  10 .\"
  11 .\" Permission is granted to copy and distribute modified versions of this
  12 .\" manual under the conditions for verbatim copying, provided that the
  13 .\" entire resulting derived work is distributed under the terms of a
  14 .\" permission notice identical to this one.
  15 .\"
  16 .\" Since the Linux kernel and libraries are constantly changing, this
  17 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  18 .\" responsibility for errors or omissions, or for damages resulting from
  19 .\" the use of the information contained herein.  The author(s) may not
  20 .\" have taken the same level of care in the production of this manual,
  21 .\" which is licensed free of charge, as they might when working
  22 .\" professionally.
  23 .\"
  24 .\" Formatted or processed versions of this manual, if unaccompanied by
  25 .\" the source, must acknowledge the copyright and authors of this work.
  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 .\" Redistribution and use in source and binary forms, with or without
  34 .\" modification, are permitted provided that the following conditions
  35 .\" are met:
  36 .\" 1. Redistributions of source code must retain the above copyright
  37 .\"    notice, this list of conditions and the following disclaimer.
  38 .\" 2. Redistributions in binary form must reproduce the above copyright
  39 .\"    notice, this list of conditions and the following disclaimer in the
  40 .\"    documentation and/or other materials provided with the distribution.
  41 .\" 3. All advertising materials mentioning features or use of this software
  42 .\"    must display the following acknowledgement:
  43 .\"     This product includes software developed by the University of
  44 .\"     California, Berkeley and its contributors.
  45 .\" 4. Neither the name of the University nor the names of its contributors
  46 .\"    may be used to endorse or promote products derived from this software
  47 .\"    without specific prior written permission.
  48 .\"
  49 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  50 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  51 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  52 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  53 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  54 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  55 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  56 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  57 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  58 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  59 .\" SUCH DAMAGE.
  60 .\"
  61 .\" Modified Mon Oct 21 23:05:29 EDT 1996 by Eric S. Raymond <esr@thyrsus.com>
  62 .\" Modified 1998 by Andi Kleen
  63 .\" $Id: bind.2,v 1.3 1999/04/23 19:56:07 freitag Exp $
  64 .\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com>
  65 .\"
  66 .\" Japanese Version Copyright (c) 1996 Yosiaki Yanagihara
  67 .\"         all rights reserved.
  68 .\" Translated 1996-06-25, Yosiaki Yanagihara <yosiaki@bsd2.kbnes.nec.co.jp>
  69 .\" Modified 1997-11-06, HANATAKA Shinya <hanataka@abyss.rim.or.jp>
  70 .\" Modified 1999-08-02, HANATAKA Shinya <hanataka@abyss.rim.or.jp>
  71 .\" Updated 2005-02-03, Yuichi SATO <ysato444@yahoo.co.jp>
  72 .\" Updated 2005-12-26, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  73 .\" Updated 2006-07-19, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.36
  74 .\" Updated 2007-06-13, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.55
  75 .\" Updated 2008-02-10, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.77
  76 .\"
  77 .TH BIND 2 2007-12-28 "Linux" "Linux Programmer's Manual"
  78 .SH 名前
  79 bind \- ソケットに名前をつける
  80 .SH 書式
  81 .nf
  82 .BR "#include <sys/types.h>" "          /* 「注意」参照 */"
  83 .B #include <sys/socket.h>
  84 .sp
  85 .BI "int bind(int " sockfd ", const struct sockaddr *" addr ,
  86 .BI "         socklen_t " addrlen );
  87 .fi
  88 .SH 説明
  89 .BR socket (2)
  90 でソケットが作成されたとき、そのソケットは名前空間 (アドレス・ファミリー) に
  91 存在するが、アドレスは割り当てられていない。
  92 .BR bind ()
  93 は、ファイルディスクリプタ
  94 .I sockfd
  95 で参照されるソケットに
  96 .I addr
  97 で指定されたアドレスを割り当てる。
  98 .I addrlen
  99 には
 100 .I addr
 101 が指すアドレス構造体のサイズをバイト単位で指定する。
 102 伝統的にこの操作は
 103 「ソケットに名前をつける」
 104 と呼ばれる。
 105 .PP
 106 .B SOCK_STREAM
 107 ソケットが接続を受け付けられるようにするには
 108 .RB ( accept (2)
 109 を参照)、通常その前に
 110 .BR bind ()
 111 を使用してローカルアドレスを割り当てる必要がある。
 112
 113 名前付けのルールはアドレス・ファミリーごとに異なっている。詳細な情報は
 114 第 7 章の各マニュアルを参照すること。
 115 .B AF_INET
 116 は
 117 .BR ip (7)
 118 を、
 119 .B AF_INET6
 120 は
 121 .BR ipv6 (7)
 122 を、
 123 .B AF_UNIX
 124 は
 125 .BR unix (7)
 126 を、
 127 .B AF_APPLETALK
 128 は
 129 .BR ddp (7)
 130 を、
 131 .B AF_PACKET
 132 は
 133 .BR packet (7)
 134 を、
 135 .B AF_X25
 136 は
 137 .BR x25 (7)
 138 を、
 139 .B AF_NETLINK
 140 は
 141 .BR netlink (7)
 142 を参照。
 143
 144 .I addr
 145 引き数に実際にどのような構造体が渡されるかは、
 146 アドレス・ファミリーに依存する。
 147 .I sockaddr
 148 構造体は以下のような感じで定義されている:
 149 .in +4n
 150 .nf
 151
 152 struct sockaddr {
 153     sa_family_t sa_family;
 154     char        sa_data[14];
 155 }
 156
 157 .fi
 158 .in
 159 この構造体は、
 160 .I addr
 161 に渡される構造体へのポインタをキャストし、
 162 コンパイラの警告メッセージを抑えるためだけに存在する。
 163 下記の「例」を参照。
 164 .SH 返り値
 165 成功すると 0 を返す。
 166 失敗すると \-1 を返し、
 167 .I errno
 168 を適切に設定する。
 169 .SH エラー
 170 .TP
 171 .B EACCES
 172 .\" e.g., privileged port in AF_INET domain
 173 そのアドレスは保護されていて、かつユーザがスーパーユーザではない。
 174 .TP
 175 .B EADDRINUSE
 176 指定されたアドレスが既に使用中である。
 177 .TP
 178 .B EBADF
 179 .I sockfd
 180 が不正なディスクリプタである。
 181 .TP
 182 .B EINVAL
 183 ソケットがすでにアドレスに結びつけ (bind) られている。
 184 .\" これは将来変更されるかもしれない。
 185 .\" 詳しくは
 186 .\" .I linux/unix/sock.c
 187 .\" を参照すること。
 188 .B ENOTSOCK
 189 .I sockfd
 190 がファイルに対するディスクリプタで、ソケットに対するものではない。
 191 .PP
 192 以下のエラーは UNIXドメイン
 193 .RB ( AF_UNIX )
 194 のソケット特有である:
 195 .TP
 196 .B EACCES
 197 パス名の構成要素に検索許可 (search permission) がない
 198 .RB ( path_resolution (7)
 199 も参照すること)。
 200 .TP
 201 .B EADDRNOTAVAIL
 202 存在しないインタフェースが要求されたか、要求されたアドレスが
 203 ローカルではなかった。
 204 .TP
 205 .B EFAULT
 206 .I addr
 207 がユーザのアクセス可能なアドレス空間の外を指している。
 208 .TP
 209 .B EINVAL
 210 .I addrlen
 211 が不正であるか、ソケットが
 212 .B AF_UNIX
 213 ファミリーではない。
 214 .TP
 215 .B ELOOP
 216 .I addr
 217 を解決する際に遭遇したシンボリック・リンクが多過ぎる。
 218 .TP
 219 .B ENAMETOOLONG
 220 .I addr
 221 が長過ぎる。
 222 .TP
 223 .B ENOENT
 224 ファイルが存在しない。
 225 .TP
 226 .B ENOMEM
 227 カーネルに、利用可能なメモリーが十分にない。
 228 .TP
 229 .B ENOTDIR
 230 パス名の構成要素がディレクトリではない。
 231 .TP
 232 .B EROFS
 233 ソケット inode が読み込み専用のファイルシステム上にある。
 234 .SH 準拠
 235 SVr4, 4.4BSD, POSIX.1-2001
 236 .RB ( bind ()
 237 は 4.2BSD で最初に現われた)。
 238 .\" SVr4 には他に、一般のエラー状態
 239 .\" .B ENOSR
 240 .\" 及び UNIX ドメインのエラー状態
 241 .\" .BR EIO ,
 242 .\" .B EISDIR
 243 .\" についての記述がある。
 244 .SH 注意
 245 POSIX.1-2001 では
 246 .I <sys/types.h>
 247 のインクルードは必須とされておらず、
 248 Linux ではこのヘッダファイルは必要ではない。
 249 しかし、歴史的には、いくつかの実装 (BSD 系) でこのヘッダファイルが
 250 必要であり、移植性が必要なアプリケーションではこのファイルを
 251 インクルードするのが賢明であろう。
 252
 253 .BR bind ()
 254 の三番目の引き数は (4.x BSD や libc4, libc5 と同様に) 実際には
 255 .I int
 256 である。glibc でも使われている現在の
 257 .I socklen_t
 258 に関して、POSIX には少し混乱がある。
 259 詳しくは
 260 .BR accept (2)
 261 を参照のこと。
 262 .SH バグ
 263 透過的プロキシ (transparent proxy) オプションについて記述していない。
 264 .\" FIXME What *are* transparent proxy options?
 265 .SH 例
 266 インターネット・ドメイン・ソケットでの
 267 .BR bind ()
 268 の利用例が
 269 .BR getaddrinfo (3)
 270 に記載されている。
 271
 272 以下の例は、UNIX ドメイン
 273 .RB ( AF_UNIX )
 274 でストリームソケットを bind する方法を示したものである。
 275 .\" listen.7 refers to this example.
 276 .\" accept.7 refers to this example.
 277 .\" unix.7 refers to this example.
 278
 279 .nf
 280 #include <sys/socket.h>
 281 #include <sys/un.h>
 282 #include <stdlib.h>
 283 #include <stdio.h>
 284 #include <string.h>
 285
 286 #define MY_SOCK_PATH "/somepath"
 287 #define LISTEN_BACKLOG 50
 288
 289 #define handle_error(msg) \\
 290     do { perror(msg); exit(EXIT_FAILURE); } while (0)
 291
 292 int
 293 main(int argc, char *argv[])
 294 {
 295     int sfd, cfd;
 296     struct sockaddr_un my_addr, peer_addr;
 297     socklen_t peer_addr_size;
 298
 299     sfd = socket(AF_UNIX, SOCK_STREAM, 0);
 300     if (sfd == \-1)
 301         handle_error("socket");
 302
 303     memset(&my_addr, 0, sizeof(struct sockaddr_un));
 304                         /* Clear structure */
 305     my_addr.sun_family = AF_UNIX;
 306     strncpy(my_addr.sun_path, MY_SOCK_PATH,
 307             sizeof(my_addr.sun_path) \- 1);
 308
 309     if (bind(sfd, (struct sockaddr *) &my_addr,
 310             sizeof(struct sockaddr_un)) == \-1)
 311         handle_error("bind");
 312
 313     if (listen(sfd, LISTEN_BACKLOG) == \-1)
 314         handle_error("listen");
 315
 316     /* Now we can accept incoming connections one
 317        at a time using accept(2) */
 318
 319     peer_addr_size = sizeof(struct sockaddr_un);
 320     cfd = accept(sfd, (struct sockaddr *) &peer_addr,
 321                  &peer_addr_size)
 322     if (cfd == \-1)
 323         handle_error("accept");
 324
 325     /* Code to deal with incoming connection(s)... */
 326
 327     /* When no longer required, the socket pathname, MY_SOCK_PATH
 328        should be deleted using unlink(2) or remove(3) */
 329 }
 330 .fi
 331 .SH 関連項目
 332 .BR accept (2),
 333 .BR connect (2),
 334 .BR getsockname (2),
 335 .BR listen (2),
 336 .BR socket (2),
 337 .BR getaddrinfo (3),
 338 .BR getifaddrs (3),
 339 .BR ip (7),
 340 .BR ipv6 (7),
 341 .BR path_resolution (7),
 342 .BR socket (7),
 343 .BR unix (7)