OSDN Git Service

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