OSDN Git Service

(split) LDP: Update release pages
[linuxjm/LDP_man-pages.git] / release / man7 / socket.7
1 .\" t
2 .\" This man page is Copyright (C) 1999 Andi Kleen <ak@muc.de>.
3 .\" and copyright (c) 1999 Matthew Wilcox.
4 .\"
5 .\" %%%LICENSE_START(VERBATIM_ONE_PARA)
6 .\" Permission is granted to distribute possibly modified copies
7 .\" of this page provided the header is included verbatim,
8 .\" and in case of nontrivial modification author and date
9 .\" of the modification is added to the header.
10 .\" %%%LICENSE_END
11 .\"
12 .\" 2002-10-30, Michael Kerrisk, <mtk.manpages@gmail.com>
13 .\"     Added description of SO_ACCEPTCONN
14 .\" 2004-05-20, aeb, added SO_RCVTIMEO/SO_SNDTIMEO text.
15 .\" Modified, 27 May 2004, Michael Kerrisk <mtk.manpages@gmail.com>
16 .\"     Added notes on capability requirements
17 .\"     A few small grammar fixes
18 .\" 2010-06-13 Jan Engelhardt <jengelh@medozas.de>
19 .\"     Documented SO_DOMAIN and SO_PROTOCOL.
20 .\" FIXME
21 .\" The following are not yet documented:
22 .\"     SO_PEERNAME (2.4?)
23 .\"             get only
24 .\"             Seems to do something similar to getpeernam(), but then
25 .\"             why is it necessary / how does it differ?
26 .\"     SO_TIMESTAMPNS (2.6.22)
27 .\"             Documentation/networking/timestamping.txt
28 .\"             commit 92f37fd2ee805aa77925c1e64fd56088b46094fc
29 .\"             Author: Eric Dumazet <dada1@cosmosbay.com>
30 .\"     SO_TIMESTAMPING (2.6.30)
31 .\"             Documentation/networking/timestamping.txt
32 .\"             commit cb9eff097831007afb30d64373f29d99825d0068
33 .\"             Author: Patrick Ohly <patrick.ohly@intel.com>
34 .\"     SO_RXQ_OVFL (2.6.33)
35 .\"             commit 3b885787ea4112eaa80945999ea0901bf742707f
36 .\"             Author: Neil Horman <nhorman@tuxdriver.com>
37 .\"     SO_WIFI_STATUS (3.3)
38 .\"             commit 6e3e939f3b1bf8534b32ad09ff199d88800835a0
39 .\"             Author: Johannes Berg <johannes.berg@intel.com>
40 .\"             Also: SCM_WIFI_STATUS
41 .\"     SO_NOFCS (3.4)
42 .\"             commit 3bdc0eba0b8b47797f4a76e377dd8360f317450f
43 .\"             Author: Ben Greear <greearb@candelatech.com>
44 .\"
45 .\"*******************************************************************
46 .\"
47 .\" This file was generated with po4a. Translate the source file.
48 .\"
49 .\"*******************************************************************
50 .\"
51 .\" Japanese Version Copyright (c) 1999 NAKANO Takeo all rights reserved.
52 .\" Translated 1999-12-06, NAKANO Takeo <nakano@apm.seikei.ac.jp>
53 .\" Updated 2003-01-20, Akihiro Motoki <amotoki@dd.iij4u.or.jp>
54 .\" Updated 2005-02-23, Akihiro MOTOKI
55 .\" Updated 2005-10-05, Akihiro MOTOKI
56 .\" Updated 2005-12-05, Akihiro MOTOKI, Catch up to LDP man-pages 2.16
57 .\" Updated 2005-12-26, Akihiro MOTOKI, Catch up to LDP man-pages 2.18
58 .\" Updated 2006-04-15, Akihiro MOTOKI, Catch up to LDP man-pages 2.29
59 .\" Updated 2007-01-05, Akihiro MOTOKI, Catch up to LDP man-pages 2.43
60 .\" Updated 2013-05-01, Akihiro MOTOKI <amotoki@gmail.com>
61 .\" Updated 2013-05-06, Akihiro MOTOKI <amotoki@gmail.com>
62 .\" Updated 2013-07-24, Akihiro MOTOKI <amotoki@gmail.com>
63 .\"
64 .TH SOCKET 7 2013\-06\-21 Linux "Linux Programmer's Manual"
65 .SH 名前
66 socket \- Linux のソケットインターフェース
67 .SH 書式
68 \fB#include <sys/socket.h>\fP
69 .sp
70 \fIsockfd\fP\fB = socket(int \fP\fIsocket_family\fP\fB, int \fP\fIsocket_type\fP\fB, int
71 \fP\fIprotocol\fP\fB);\fP
72 .SH 説明
73 このマニュアルページは Linux ネットワークのソケット層に対する ユーザインターフェースを記述するものである。 BSD
74 互換ソケットは、ユーザプロセスとカーネル内部の ネットワークプロトコルスタック群との間に、 統一的なインターフェースを提供するものである。
75 プロトコルモジュールは \fIプロトコルファミリー (protocol familiy)\fP (例: \fBAF_INET\fP, \fBAF_IPX\fP,
76 \fBAF_PACKET\fP)  と \fIソケットタイプ (socket types)\fP (例: \fBSOCK_STREAM\fP,
77 \fBSOCK_DGRAM\fP)  に分類できる。 これらに関するより詳しい情報は \fBsocket\fP(2)  を参照のこと。
78 .SS ソケット層の関数群
79 これらの関数はユーザプロセスがパケットを送受信したり、その他のソケット操作を 行ったりするために用いられる。詳細はそれぞれのマニュアルページを
80 見てほしい。
81
82 \fBsocket\fP(2)  はソケットを生成する。 \fBconnect\fP(2)  はソケットをリモートのソケットアドレスに接続する。
83 \fBbind\fP(2)  はソケットをローカルのソケットアドレスにバインドする。 \fBlisten\fP(2)
84 はソケットに新しい接続が来たら受信するように伝え、 \fBaccept\fP(2)  は外部からやってきた接続に対して新しいソケットを得るために用いられる。
85 \fBsocketpair\fP(2)  は互いに接続された二つの名前無しソケット (anonymous socket) を返す (\fBAF_UNIX\fP
86 のような、いくつかのローカルなファミリーでしか実装されていない)。
87 .PP
88 \fBsend\fP(2), \fBsendto\fP(2), \fBsendmsg\fP(2)  はソケットを通してデータを送信し、 \fBrecv\fP(2)
89 \fBrecvfrom\fP(2), \fBrecvmsg\fP(2)  はソケットからデータを受信する。 \fBpoll\fP(2)  と \fBselect\fP(2)
90 はデータの到着を待ったり、データ送信の準備ができるまで待ったりする。 さらに、 \fBwrite\fP(2), \fBwritev\fP(2),
91 \fBsendfile\fP(2), \fBread\fP(2), \fBreadv\fP(2)  のような標準的な I/O 操作もデータの読み書きに用いることができる。
92 .PP
93 \fBgetsockbyname\fP(2)  はローカルのソケットアドレスを返し、 \fBgetpeername\fP(2)
94 はリモートのソケットアドレスを返す。 \fBgetsockopt\fP(2)  と \fBsetsockopt\fP(2)
95 はソケット層のオプションやプロトコルオプションの取得・設定に用いられる。 他のいくつかのオプションの取得・設定には \fBioctl\fP(2)
96 を使うことができる。
97 .PP
98 \fBclose\fP(2)  はソケットをクローズする。 \fBshutdown\fP(2)  は全二重なソケット接続を部分的にクローズする。
99 .PP
100 シーク動作や、 0 以外の位置に対する \fBpread\fP(2)  や \fBpwrite\fP(2)  はソケットではサポートされていない。
101 .PP
102 非ブロッキングな I/O をソケットで行うことは可能で、 \fBfcntl\fP(2)  を使ってソケットのファイルディスクリプタに
103 \fBO_NONBLOCK\fP フラグをセットすれば良い。 こうするとブロックされる操作は、 (通常)  \fBEAGAIN\fP エラーで戻ることになる
104 (後で処理が再試行されることが期待されている)。 \fBconnect\fP(2)  では \fBEINPROGRESS\fP エラーが返される。
105 この場合、ユーザはさまざまなイベントを \fBpoll\fP(2)  や \fBselect\fP(2)  を使って待つことができる。
106 .TS
107 tab(:) allbox;
108 c s s
109 l l l.
110 I/O イベント
111 イベント:poll フラグ:内容
112 Read:POLLIN:T{
113 新しいデータが到着した。
114 T}
115 Read:POLLIN:T{
116 (接続志向のソケットで)
117 接続の設定が終了した。
118 T}
119 Read:POLLHUP:T{
120 接続先で切断要求が生成された。
121 T}
122 Read:POLLHUP:T{
123 接続が壊れた (接続志向のプロトコルのみ)。
124 この場合、ソケットに書き込みが行われると
125 \fBSIGPIPE\fP
126 も送信される。
127 T}
128 Write:POLLOUT:T{
129 ソケットには新しいデータを書き込むのに十分なバッファがある。
130 T}
131 Read/Write:T{
132 POLLIN|
133 .br
134 POLLOUT
135 T}:T{
136 外部向けの
137 \fBconnect\fP(2)
138 が終了した。
139 T}
140 Read/Write:POLLERR:非同期的 (asynchronous) なエラーが起こった。
141 Read/Write:POLLHUP:接続先が片方向を切断した。
142 Exception:POLLPRI:T{
143 緊急データ (urgent data) が到着した。この場合は
144 \fBSIGURG\fP
145 が送信される。
146 T}
147 .\" FIXME . The following is not true currently:
148 .\" It is no I/O event when the connection
149 .\" is broken from the local end using
150 .\" .BR shutdown (2)
151 .\" or
152 .\" .BR close (2).
153 .TE
154 .PP
155 \fBpoll\fP(2)  や \fBselect\fP(2)  を使う代わりに、カーネルからアプリケーションに イベントを通知させるのに \fBSIGIO\fP
156 シグナルを使う方法もある。 この方法を使うには、 \fBfcntl\fP(2)  を用いてソケットのファイルディスクリプタに \fBO_ASYNC\fP
157 フラグをセットし、 \fBSIGIO\fP に対する有効なシグナルハンドラを \fBsigaction\fP(2)  によって設定しておく必要がある。 後述の
158 \fIシグナル\fP に関する議論も参考にすること。
159 .SS ソケットアドレス構造体
160 各ソケットドメインにはそれぞれ独自のソケットアドレス形式があり、ドメイン固有のアドレス構造体を持っている。
161 これらの構造体の先頭には、アドレス構造体の種類を示す整数の "family" フィールド (型は \fIsa_family_t\fP) がある。
162 このフィールドにより、 すべてのソケットドメインで汎用的に使用されるシステムコール (例えば、 \fBconnect\fP(2), \fBbind\fP(2),
163 \fBaccept\fP(2), \fBgetsockname\fP(2), \fBgetpeername\fP(2) など)
164 が、特定のソケットアドレスのドメインを判定することができる。
165
166 任意の種類のソケットアドレスをソケット API のインターフェースに渡せるように、 \fIstruct sockaddr\fP 型が定義されている。
167 この型の目的は、 純粋に、 ドメイン固有のソケットアドレスを 「汎用的な」型にキャストできるようにする点にある。 これにより、 ソケット API
168 呼び出しにおいて、 コンパイラが型の不一致の警告を出すのを避けることができる。
169
170 これに加えて、ソケット API ではデータ型 \fIstruct sockaddr_storage\fP が提供されている。
171 サポートしているすべてのドメイン固有のソケットアドレス構造体を収容するのに、この型を使うことができる。 この型は十分な大きさがあり、(メモリ境界への)
172 アラインも適切に行われている (特に、 IPv6 ソケットアドレスを収容するのにも十分な大きさである)。 この構造体には次のフィールドがあり、
173 このフィールドを使って、 この構造体に実際に格納されているソケットアドレスの型を特定することができる。
174
175 .in +4n
176 .nf
177     sa_family_t ss_family;
178 .fi
179 .in
180
181 \fIsockaddr_storage\fP 構造体は、 ソケットアドレスを汎用的な方法で扱う必要があるプログラム (例えば、 IPv4 と IPv6
182 の両方のソケットアドレスを扱う必要があるプログラム) で有用である。
183 .SS ソケットオプション
184 .\" FIXME
185 .\" In the list below, the text used to describe argument types
186 .\" for each socket option should be more consistent
187 .\"
188 .\" SO_ACCEPTCONN is in POSIX.1-2001, and its origin is explained in
189 .\" W R Stevens, UNPv1
190 これらのソケットオプションは、 \fBsetsockopt\fP(2)  を用いれば設定でき、 \fBgetsockopt\fP(2)  を用いれば取得できる。
191 但し、どのソケットの場合も ソケットレベルには \fBSOL_SOCKET\fP を指定すること。 注釈がない限り、 \fIoptval\fP は \fIint\fP
192 へのポインタである。
193 .TP 
194 \fBSO_ACCEPTCONN\fP
195 このソケットが \fBlisten\fP(2)  によって接続待ち受け状態に設定されているかどうかを示す値を返す。 値 0 は listen
196 状態のソケットでないことを、 値 1 は listen 状態のソケットであることを示す。このソケットオプションは読み込み専用である。
197 .TP 
198 \fBSO_BINDTODEVICE\fP
199 このソケットを、引き数で渡したインターフェース名で指定される (\(lqeth0\(rq のような) 特定のデバイスにバインドする。
200 名前が空文字列だったり、オプションの長さ (optlen) が 0 の場合には、 ソケットのバインドが削除される。
201 渡すオプションは、インターフェース名が 入ったヌル文字で終端された可変長の文字列である。 文字列の最大のサイズは \fBIFNAMSIX\fP である。
202 ソケットがインターフェースにバインドされると、 その特定のインターフェースから受信されたパケットだけを処理する。
203 このオプションはいくつかのソケットタイプ、 特に \fBAF_INET\fP に対してのみ動作する点に注意すること。 パケットソケットではサポートされていない
204 (通常の \fBbind\fP(2) を使うこと)。
205
206 Linux 3.8 より前のバージョンでは、このソケットオプションは \fBgetsockname\fP(2)
207 で設定することはできたが、取得することができなかった。 Linux 3.8 以降では、読み出すことができる。 \fIoptlen\fP 引き数には、
208 デバイス名を格納するのに十分なバッファサイズを渡すべきであり、 \fBIFNAMSIZ\fP バイトにすることを推奨する。 実際のデバイス名の長さは
209 \fIoptlen\fP 引き数に格納されて返される。
210 .TP 
211 \fBSO_BROADCAST\fP
212 ブロードキャストフラグを設定・取得する。有効になっていると、データグラ
213 ムソケットはブロードキャストアドレスにパケットを送信できるようになる。
214 ストリーム指向のソケットには何の効果もない。
215 .TP 
216 \fBSO_BSDCOMPAT\fP
217 BSD のバグに対して互換性を取るための機能を有効にする。 この機能は Linux 2.0 と 2.2 の UDP
218 プロトコルモジュールで使用されている。 有効になっていると、 UDP ソケットで受信された ICMP エラーは ユーザプログラムに渡されない。
219 これ以降のバージョンのカーネルでは、このオプションのサポートは 段階的に廃止されてきた。 Linux 2.4 ではこのオプションは黙って無視され、
220 Linux 2.6 ではプログラムがこのオプションを使用すると (printk() を使って)  カーネルの警告メッセージが出力される。 Linux
221 2.0 では、このオプションを指定すると、 raw ソケットにおいても BSD のバグ (ランダムヘッダ変更、 ブロードキャストフラグのスキップ)
222 に対する互換機能が有効になっていた。 しかし、こちらは Linux 2.2 で削除された。
223 .TP 
224 \fBSO_DEBUG\fP
225 ソケットのデバッグ機能を有効にする。 \fBCAP_NET_ADMIN\fP 権限を持つプロセスか、実効ユーザ ID が 0 のプロセスでしか 利用できない。
226 .TP 
227 \fBSO_DOMAIN\fP (Linux 2.6.32 以降)
228 ソケットドメインを整数で取得する。 \fBAF_INET6\fP のような値が返される。
229 詳細は \fBsocket\fP(2) を参照。このソケットオプションは読み込み専用である。
230 .TP 
231 \fBSO_ERROR\fP
232 保留になっていたソケットエラーを取得してクリアする。
233 このソケットオプションは読み込み専用である。整数値をとる。
234 .TP 
235 \fBSO_DONTROUTE\fP
236 ゲートウェイを経由せず、直接接続されているホストにのみ送信する。 \fBsend\fP(2)  操作で \fBMSG_DONTROUTE\fP
237 フラグをセットした場合も同じ効果が得られる。 ブール整数のフラグを取る。
238 .TP 
239 \fBSO_KEEPALIVE\fP
240 接続志向のソケットに対する keep\-alive メッセージの送信を有効にする。 ブール値の整数フラグをとる。
241 .TP 
242 \fBSO_LINGER\fP
243 \fBSO_LINGER\fP オプションを取得・設定する。引き数には \fIlinger\fP 構造体を取る。
244 .sp
245 .in +4n
246 .nf
247 struct linger {
248     int l_onoff;    /* linger active */
249     int l_linger;   /* how many seconds to linger for */
250 };
251 .fi
252 .in
253 .IP
254 有効になっていると、 \fBclose\fP(2)  や \fBshutdown\fP(2)
255 は、そのソケットにキューイングされたメッセージがすべて送信完了するか、 linger (居残り) タイムアウトになるまで返らない。無効になっていると、
256 これらのコールはただちに戻り、クローズ動作はバックグラウンドで行われる。 ソケットのクローズを \fBexit\fP(2)
257 の一部として行った場合には、残っているソケットの クローズ動作は必ずバックグラウンドに送られる。
258 .TP 
259 \fBSO_MARK\fP (Linux 2.6.25 以降)
260 .\" commit 4a19ec5800fc3bb64e2d87c4d9fdd9e636086fe0
261 .\" and    914a9ab386a288d0f22252fc268ecbc048cdcbd5
262 このソケットから送信される各パケットにマークをセットする (netfilter の MARK ターゲットと似ているが、ソケット単位である点が異なる)。
263 マークの変更は、 netfilter なしでのマークに基づいてのルーティングや、 パケットフィルタリングに使うことができる。
264 このオプションを変更するには \fBCAP_NET_ADMIN\fP ケーパビリティが必要である。
265 .TP 
266 \fBSO_OOBINLINE\fP
267 .\" don't document it because it can do too much harm.
268 .\".B SO_NO_CHECK
269 このオプションを有効にすると、帯域外データ (out\-of\-band data) は 受信データストリーム中に置かれる。有効にしなければ、
270 帯域外データは受信時に \fBMSG_OOB\fP フラグがセットされている場合に限って渡される。
271 .TP 
272 \fBSO_PASSCRED\fP
273 .\" FIXME Document SO_PASSSEC, added in 2.6.18; there is some info
274 .\" in the 2.6.18 ChangeLog
275 \fBSCM_CREDENTIALS\fP 制御メッセージの受信を有効/無効にする。詳細は \fBunix\fP(7)  を参照のこと。
276 .TP 
277 \fBSO_PEEK_OFF\fP (Linux 3.4 以降)
278 .\" commit ef64a54f6e558155b4f149bb10666b9e914b6c54
279 \fBMSG_PEEK\fP フラグと一緒に使用された場合 \fBrecv\fP(2) システムコールの "peek offset"
280 にこのオプションの値が設定される。現在のところ、このオプションは \fBunix\fP(7) ソケットでのみサポートされている。
281
282 このオプションが負の値に設定された場合、従来の動作となる。 つまり \fBMSG_PEEK\fP フラグが指定された \fBrecv\fP(2)
283 は、キューの先頭のデータに対して peek 処理を行う (データを読み出すが、キューからデータの削除を行わない)。
284 新規のソケットではこのオプションの値は必ず \-1 に設定される。
285
286 このオプションに 0 以上の値が設定されると、 そのソケットのキュー上のオプション値で指定されたバイトオフセットにあるデータが次の peek
287 処理で返される。 同時に、 "peek offset" がキューから peek 処理されたバイト数だけ加算される。したがって、次の peek
288 処理ではキューのその次にあるデータが返される。
289
290 \fBrecv\fP(2) (や同様のシステムコール) の \fBMSG_PEEK\fP フラグなしの呼び出しでキューの先頭のデータが削除された場合、 "peek
291 offset" は削除されたバイト数だけ減算される。 言い換えると、 \fBMSG_PEEK\fP フラグなしでデータを受信すると、 "peek
292 offset" が指すキュー内の相対的な位置が狂わないように調整され、この後の peek では、
293 データ削除が行われなかった場合に返されたのと同じ値が返されるということである。
294
295 データグラムソケットでは、 "peek offset" がパケットの途中を指している場合には、 返されるデータには \fBMSG_TRUNC\fP
296 フラグが付与される。
297
298 以下の例は \fBSO_PEEK_OFF\fP の利用例を示している。ストリームソケットのキューに以下の入力データが入っているものとする。
299
300     aabbccddeeff
301
302 .IP
303 以下の順序で \fBrecv\fP(2) の呼び出しを行うと、コメントに書かれた結果となる。
304
305 .in +4n
306 .nf
307 int ov = 4;                  // Set peek offset to 4
308 setsockopt(fd, SOL_SOCKET, SO_PEEK_OFF, &ov, sizeof(ov));
309
310 recv(fd, buf, 2, MSG_PEEK);  // Peeks "cc"; offset set to 6
311 recv(fd, buf, 2, MSG_PEEK);  // Peeks "dd"; offset set to 8
312 recv(fd, buf, 2, 0);         // Reads "aa"; offset set to 6
313 recv(fd, buf, 2, MSG_PEEK);  // Peeks "ee"; offset set to 8
314 .fi
315 .in
316 .TP 
317 \fBSO_PEERCRED\fP
318 このソケットに接続してきた外部プロセスの信任状 (credential) を返す。このソケットオプションが利用できるのは、接続された
319 \fBAF_UNIX\fP ストリームソケット間、および \fBsocketpair\fP(2) を使って作成された \fBAF_UNIX\fP
320 のストリームソケットとデータグラムソケットのペアだけである。 \fBunix\fP(7)  を参照のこと。 \fBconnect\fP(2) や
321 \fBsocketpair\fP(2) が呼ばれた時に有効であった信任状が返される。引き数は \fIucred\fP
322 構造体である。このソケットオプションは読み込み専用である。
323 .TP 
324 \fBSO_PRIORITY\fP
325 プロトコルで定義された優先度を、このソケットから 送信される全てのパケットにセットする。 Linux はネットワークキュー内部の
326 整列にこの値を用いる。高い優先度を持っているパケットは先に処理される。 ただしそのデバイスのキュー処理のやり方に依存する。 \fBip\fP(7)
327 では、外向けパケットの IP type\-of\-service (TOS) フィールドにもこの値が設定される。 0 から 6 以外の優先度をセットするには
328 \fBCAP_NET_ADMIN\fP ケーパビリティが必要である。
329 .TP 
330 \fBSO_PROTOCOL\fP (Linux 2.6.32 以降)
331 ソケットのプロトコルを整数で取得する。 \fBIPPROTO_SCTP\fP のような値が返される。
332 詳細は \fBsocket\fP(2) を参照。このソケットオプションは読み込み専用である。
333 .TP 
334 \fBSO_RCVBUF\fP
335 .\" Most (all?) other implementations do not do this -- MTK, Dec 05
336 .\" The following thread on LMKL is quite informative:
337 .\" getsockopt/setsockopt with SO_RCVBUF and SO_SNDBUF "non-standard" behaviour
338 .\" 17 July 2012
339 .\" http://thread.gmane.org/gmane.linux.kernel/1328935
340 ソケットの受信バッファの最大サイズを設定・取得する (バイト単位)。 \fBsetsockopt\fP(2)  を使って値が設定されたときに
341 (管理オーバヘッド用の領域を確保するために)  カーネルはこの値を 2倍し、 \fBgetsockopt\fP(2)  はこの 2倍された値を返す。
342 デフォルトの値は \fI/proc/sys/net/core/rmem_default\fP ファイルで設定され、許容される最大の値は
343 \fI/proc/sys/net/core/rmem_max\fP ファイルで設定される。 このオプションの最小値は (2倍した値で) 256 である。
344 .TP 
345 \fBSO_RCVBUFFORCE\fP (Linux 2.6.14 以降)
346 このソケットオプションを使うと、特権プロセス (\fBCAP_NET_ADMIN\fP を持つプロセス) は \fBSO_RCVBUF\fP
347 と同じことを実行できる。 ただし、上限 \fIrmem_max\fP を上書きすることができる。
348 .TP 
349 \fBSO_RCVLOWAT\fP と \fBSO_SNDLOWAT\fP
350 .\" See http://marc.theaimsgroup.com/?l=linux-kernel&m=111049368106984&w=2
351 .\" Tested on kernel 2.6.14 -- mtk, 30 Nov 05
352 バッファ中に溜めることのできるデータの最小値を指定する。 このサイズを越えると、ソケット層はそのデータをプロトコルに渡し
353 (\fBSO_SNDLOWAT\fP)、 受信時にはユーザに渡す (\fBSO_RCVLOWAT\fP)。 これら二つの値は 1 に初期化される。
354 \fBSO_SNDLOWAT\fP は Linux では変更できない (\fBsetsockopt\fP(2)  は \fBENOPROTOOPT\fP
355 エラーで失敗する)。 \fBSO_RCVLOWAT\fP は Linux 2.4 以降でのみ変更可能である。 現状、Linux ではシステムコール
356 \fBselect\fP(2)  と \fBpoll\fP(2)  は \fBSO_RCVLOWAT\fP の設定を考慮に入れずに動作し、
357 データが1バイト利用可能になっただけでも、 ソケットは読み出し可能とのマークをつける。 一方、それに続けて行うソケットからの read は
358 \fBSO_RCVLOWAT\fP バイトのデータが利用可能になるまで停止してしまう。
359 .TP 
360 \fBSO_RCVTIMEO\fP と \fBSO_SNDTIMEO\fP
361 .\" Not implemented in 2.0.
362 .\" Implemented in 2.1.11 for getsockopt: always return a zero struct.
363 .\" Implemented in 2.3.41 for setsockopt, and actually used.
364 .\" in fact to EAGAIN
365 送信・受信のタイムアウトを指定する。これを越えるとエラーを報告する。 引き数は \fIstruct timeval\fP である。
366 入出力関数がタイムアウト時間の間ブロックされ、かつデータの送信または 受信が行われていた場合は、転送されたデータ量が関数の返り値となる。
367 何もデータが転送されずにタイムアウトに達した場合は、 \-1 を返し、 \fIerrno\fP に \fBEAGAIN\fP か \fBEWOULDBLOCK\fP か
368 \fBEINPROGRESS\fP (\fBconnect\fP(2) の場合) が設定され、 あたかもソケットに非ブロッキングが指定されたように見える。
369 タイムアウト値に (デフォルト値である) 0 に設定すると、 操作は決してタイムアウトしなくなる。 タイムアウトが影響を及ぼすのは、 ソケット I/O
370 を実行するシステムコールだけ (例えば \fBread\fP(2), \fBrecvmsg\fP(2), \fBsend\fP(2), \fBsendmsg\fP(2))
371 である。 \fBselect\fP(2), \fBpoll\fP(2), \fBepoll_wait\fP(2)  などにはタイムアウトは影響を及ぼさない。
372 .TP 
373 \fBSO_REUSEADDR\fP
374 \fBbind\fP(2)  コールに与えられたアドレスが正しいかを判断するルールで、 ローカルアドレスの再利用を可能にする。 つまり \fBAF_INET\fP
375 ソケットなら、そのアドレスにバインドされたアクティブな listen 状態のソケットが存在しない限り、バインドが行える。 listen
376 状態のソケットがアドレス \fBINADDR_ANY\fP で特定のポートにバインドされている場合には、
377 このポートに対しては、どんなローカルアドレスでもバインドできない。 引き数はブール整数のフラグである。
378 .TP 
379 \fBSO_SNDBUF\fP
380 .\" Most (all?) other implementations do not do this -- MTK, Dec 05
381 .\" See also the comment to SO_RCVBUF (17 Jul 2012 LKML mail)
382 ソケットの送信バッファの最大サイズを設定・取得する (バイト単位)。 \fBsetsockopt\fP(2)  を使って値が設定されたときに
383 (管理オーバヘッド用の領域を確保するために)  カーネルはこの値を 2倍し、 \fBgetsockopt\fP(2)  はこの 2倍された値を返す。
384 デフォルトの値は \fI/proc/sys/net/core/wmem_default\fP ファイルで設定され、許容される最大の値は
385 \fI/proc/sys/net/core/wmem_max\fP ファイルで設定される。 このオプションの最小値は (2倍した値で) 2048 である。
386 .TP 
387 \fBSO_SNDBUFFORCE\fP (Linux 2.6.14 以降)
388 このソケットオプションを使うと、特権プロセス (\fBCAP_NET_ADMIN\fP を持つプロセス) は \fBSO_SNDBUF\fP
389 と同じことを実行できる。 ただし、上限 \fIwmem_max\fP を上書きすることができる。
390 .TP 
391 \fBSO_TIMESTAMP\fP
392 \fBSO_TIMESTAMP\fP 制御メッセージの受信を有効/無効にする。 タイムスタンプ制御メッセージはレベル \fBSOL_SOCKET\fP で送信され、
393 \fIcmsg_data\fP フィールドはこのシステムコールでユーザに渡した 最後のパケットの受信時刻を示す \fIstruct timeval\fP である。
394 制御メッセージの詳細については \fBcmsg\fP(3)  を参照。
395 .TP 
396 \fBSO_TYPE\fP
397 ソケットのタイプを整数で取得する (例: \fBSOCK_STREAM\fP)。
398 このソケットオプションは読み出し専用である。
399 .SS シグナル
400 (ローカルもしくはリモート側で) 切断された 接続指向 (connection\-oriented) のソケットに対して
401 書き込みを行うと、その書き込みを行ったプロセスに \fBSIGPIPE\fP が送られ、 \fBEPIPE\fP が返される。 write 呼び出しに
402 \fBMSG_NOSIGNAL\fP フラグを指定していた場合はシグナルは送られない。
403 .PP
404 \fBFIOSETOWN\fP \fBfcntl\fP(2)  や \fBSIOCSPGRP\fP \fBioctl\fP(2)
405 をプロセスまたはプロセスグループに指定しておくと、 I/O イベントが起きたときに \fBSIGIO\fP が送られる。 \fBpoll\fP(2)  や
406 \fBselect\fP(2)  をシグナルハンドラ内で用いれば、どのソケットでイベントが起こったかを 知ることができる。 (Linux 2.2 における)
407 別の方法としては、 \fBF_SETSIG\fP \fBfcntl\fP(2)  を用いてリアルタイムシグナルを設定するやり方もある。
408 リアルタイムシグナルのハンドラは、 \fIsiginfo_t\fP の \fIsi_fd\fP フィールドにファイルディスクリプタが入った状態で呼び出される。
409 詳細は \fBfcntl\fP(2)  を参照のこと。
410 .PP
411 .\" .SS Ancillary messages
412 状況によっては (例えば複数のプロセスが一つのソケットにアクセスしているなど)、 \fBSIGIO\fP
413 の原因となった状態は、プロセスがそのシグナルへの対応を行ったときには 消えてしまっているかもしれない。
414 この場合は、プロセスは再び待つようにすべきである。 Linux は同じシグナルを後で再送するからである。
415 .SS "/proc インタフェース"
416 core のソケットのネットワーキングパラメータには、 \fI/proc/sys/net/core/\fP ディレクトリ内のファイルを通してアクセスできる。
417 .TP 
418 \fIrmem_default\fP
419 ソケットの受信バッファサイズのデフォルト値 (バイト単位)。
420 .TP 
421 \fIrmem_max\fP
422 \fBSO_RCVBUF\fP ソケットオプションを用いてユーザが設定できる ソケットの受信バッファサイズの最大値 (バイト単位)。
423 .TP 
424 \fIwmem_default\fP
425 ソケットの送信バッファサイズのデフォルト値 (バイト単位)。
426 .TP 
427 \fIwmem_max\fP
428 \fBSO_SNDBUF\fP ソケットオプションを用いてユーザが設定できる ソケットの送信バッファサイズの最大値 (バイト単位)。
429 .TP 
430 \fImessage_cost\fP と \fImessage_burst\fP
431 トークン・バケット・フィルターを設定する。 これは外部のネットワークイベントによって引き起こされた 負荷限界の警告メッセージに用いられる。
432 .TP 
433 \fInetdev_max_backlog\fP
434 グローバルな入力キューにおける最大のパケット数。
435 .TP 
436 \fIoptmem_max\fP
437 .\" netdev_fastroute is not documented because it is experimental
438 ソケットあたりの、補助データ (ancillary data) とユーザ制御データ (iovecs のようなもの) との和の最大長。
439 .SS ioctl
440 以下に示す操作には \fBioctl\fP(2)  を用いてアクセスできる。
441
442 .in +4n
443 .nf
444 \fIerror\fP\fB = ioctl(\fP\fIip_socket\fP\fB, \fP\fIioctl_type\fP\fB, \fP\fI&value_result\fP\fB);\fP
445 .fi
446 .in
447 .TP 
448 \fBSIOCGSTAMP\fP
449 .\"
450 最後にユーザに渡されたパケットの受信タイムスタンプを \fIstruct timeval\fP に入れて返す。 これは round trip
451 時間を正確に測りたいときに便利である。 \fIstruct timeval\fP の説明は \fBsetitimer\fP(2)  を見てほしい。 この ioctl
452 は、ソケットオプション \fBSO_TIMESTAMP\fP がソケットにセットされていない場合にのみ使用すべきである。 さもなければ、この ioctl は
453 \fBSO_TIMESTAMP\fP がセットされていなかった間に受信した最後のパケットの時刻を返すか、 そのようなパケットを受信していない場合には失敗する
454 (つまり、 \fBioctl\fP(2)  は \-1 を返し、 \fIerrno\fP に \fBENOENT\fP をセットする)。
455 .TP 
456 \fBSIOCSPGRP\fP
457 非同期 I/O 操作の終了時や緊急データの受信時に \fBSIGIO\fP や \fBSIGURG\fP シグナル群を送るプロセスやプロセスグループを設定する。
458 引き数は \fIpid_t\fP へのポインタである。 引き数が正だと、そのプロセスにシグナルが送られる。負だと、 引き数の絶対値を ID
459 に持つプロセスグループにシグナルが送られる。 シグナル受信先には、自分自身のプロセス / 自分の所属するプロセスグループ しか指定できない。但し、
460 \fBCAP_KILL\fP ケーパビリティを持っている場合、及び実効ユーザ ID が 0 のプロセスの場合は この限りではない。
461 .TP 
462 \fBFIOASYNC\fP
463 \fBO_ASYNC\fP フラグを変更し、ソケットの非同期 (asynchronous) I/O モードを 有効/無効にする。非同期 I/O モードでは、
464 新しい I/O イベントが起きたときに、 \fBSIGIO\fP シグナルや \fBF_SETSIG\fP で設定されたシグナル・セットが発行される。
465 .IP
466 .\"
467 引き数はブール整数のフラグである。 (この操作は \fBfcntl\fP(2)  を使って \fBO_ASYNC\fP フラグをセットするのと同じ意味である。)
468 .TP 
469 \fBSIOCGPGRP\fP
470 \fBSIGIO\fP や \fBSIGURG\fP を受信したカレントプロセス・プロセスグループを取得する。 ない場合は 0 が返る。
471 .PP
472 有効な \fBfcntl\fP(2)  操作:
473 .TP 
474 \fBFIOGETOWN\fP
475 \fBSIOCGPGRP\fP \fBioctl\fP(2)  と同じ。
476 .TP 
477 \fBFIOSETOWN\fP
478 \fBSIOCSPGRP\fP \fBioctl\fP(2)  と同じ。
479 .SH バージョン
480 \fBSO_BINDTODEVICE\fP は Linux 2.0.30 で導入された。 \fBSO_PASSCRED\fP は Linux 2.2 で登場した。
481 \fI/proc\fP インタフェースは Linux 2.2 で導入された。 \fBSO_RCVTIMEO\fP と \fBSO_SNDTIMEO\fP は Linux
482 2.3.41 以降でサポートされている。 それ以前は、タイムアウトはプロトコル固有の固定の設定値で、 読み書きをすることはできなかった。
483 .SH 注意
484 Linux は、送受信バッファの半分を内部のカーネル構造体で用いると仮定している。 したがって、対応する \fI/proc\fP
485 ファイルはネットワーク回線上での大きさの 2 倍になる。
486
487 Linux では、 \fBSO_REUSEADDR\fP オプションでポートの再利用が許可されるのは、 そのポートに対して \fBbind\fP(2)
488 を前に実行したプログラムとそのポートを再利用 しようとするプログラムの両方で \fBSO_REUSEADDR\fP がセットされた場合のみである。 この動作は
489 (FreeBSD などの) いくつかの実装とは異なる。これらでは、 後でポートを再利用しようとするプログラムで \fBSO_REUSEADDR\fP
490 オプションをセットするだけでよい。 たいていはこの違いは見えない。なぜなら、例えばサーバプログラムは
491 常にこのオプションをセットするように設計されるからである。
492 .SH バグ
493 .\" FIXME Document SO_ATTACH_FILTER and SO_DETACH_FILTER
494 .\" .SH AUTHORS
495 .\" This man page was written by Andi Kleen.
496 \fBCONFIG_FILTER\fP ソケットオプションである \fBSO_ATTACH_FILTER\fP と \fBSO_DETACH_FILTER\fP
497 について記載されていない。これらは libpcap ライブラリを通して 用いる方が良い。
498 .SH 関連項目
499 \fBgetsockopt\fP(2), \fBconnect\fP(2), \fBsetsockopt\fP(2), \fBsocket\fP(2),
500 \fBcapabilities\fP(7), \fBddp\fP(7), \fBip\fP(7), \fBpacket\fP(7), \fBtcp\fP(7), \fBudp\fP(7),
501 \fBunix\fP(7)
502 .SH この文書について
503 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.54 の一部
504 である。プロジェクトの説明とバグ報告に関する情報は
505 http://www.kernel.org/doc/man\-pages/ に書かれている。