OSDN Git Service

(split) LDP: Update the version to 3.53 in PO files
[linuxjm/LDP_man-pages.git] / release / man7 / socket.7
index 4443ad1..56a4a9f 100644 (file)
@@ -1,11 +1,13 @@
 .\" t
-.\" Don't change the first line, it tells man that we need tbl.
 .\" This man page is Copyright (C) 1999 Andi Kleen <ak@muc.de>.
 .\" and copyright (c) 1999 Matthew Wilcox.
+.\"
+.\" %%%LICENSE_START(VERBATIM_ONE_PARA)
 .\" Permission is granted to distribute possibly modified copies
 .\" of this page provided the header is included verbatim,
 .\" and in case of nontrivial modification author and date
 .\" of the modification is added to the header.
+.\" %%%LICENSE_END
 .\"
 .\" 2002-10-30, Michael Kerrisk, <mtk.manpages@gmail.com>
 .\"    Added description of SO_ACCEPTCONN
 .\"    Documented SO_DOMAIN and SO_PROTOCOL.
 .\" FIXME
 .\" The following are not yet documented:
-.\"    SO_PEERNAME
-.\"    SO_TIMESTAMPNS
-.\"    SO_MARK (see https://bugzilla.kernel.org/show_bug.cgi?id=16461)
+.\"    SO_PEERNAME (2.4?)
+.\"            get only
+.\"            Seems to do something similar to getpeernam(), but then
+.\"            why is it necessary / how does it differ?
+.\"    SO_TIMESTAMPNS (2.6.22)
+.\"            Documentation/networking/timestamping.txt
+.\"            commit 92f37fd2ee805aa77925c1e64fd56088b46094fc
+.\"            Author: Eric Dumazet <dada1@cosmosbay.com>
 .\"    SO_TIMESTAMPING (2.6.30)
+.\"            Documentation/networking/timestamping.txt
+.\"            commit cb9eff097831007afb30d64373f29d99825d0068
+.\"            Author: Patrick Ohly <patrick.ohly@intel.com>
 .\"    SO_RXQ_OVFL (2.6.33)
+.\"            commit 3b885787ea4112eaa80945999ea0901bf742707f
+.\"            Author: Neil Horman <nhorman@tuxdriver.com>
+.\"    SO_WIFI_STATUS (3.3)
+.\"            commit 6e3e939f3b1bf8534b32ad09ff199d88800835a0
+.\"            Author: Johannes Berg <johannes.berg@intel.com>
+.\"            Also: SCM_WIFI_STATUS
+.\"    SO_NOFCS (3.4)
+.\"            commit 3bdc0eba0b8b47797f4a76e377dd8360f317450f
+.\"            Author: Ben Greear <greearb@candelatech.com>
 .\"
 .\"*******************************************************************
 .\"
 .\" This file was generated with po4a. Translate the source file.
 .\"
 .\"*******************************************************************
-.TH SOCKET 7 2012\-04\-23 Linux "Linux Programmer's Manual"
+.TH SOCKET 7 2013\-06\-21 Linux "Linux Programmer's Manual"
 .SH 名前
 socket \- Linux のソケットインターフェース
 .SH 書式
@@ -93,7 +112,7 @@ Read:POLLHUP:T{
 も送信される。
 T}
 Write:POLLOUT:T{
\82½ã\82±ã\83\83ã\83\88ã\81«ã\81¯æ\96°ã\81\97ã\81\84ã\83\87ã\83¼ã\82¿ã\82\92æ\9b¸ã\81\8dè¾¼ã\82\80ã\81®ã\81«å\85\85å\88\86ã\81ªã\83\90ã\83\83ã\83\95ã\82¡é \98å\9f\9fがある。
\82½ã\82±ã\83\83ã\83\88ã\81«ã\81¯æ\96°ã\81\97ã\81\84ã\83\87ã\83¼ã\82¿ã\82\92æ\9b¸ã\81\8dè¾¼ã\82\80ã\81®ã\81«å\8d\81å\88\86ã\81ªã\83\90ã\83\83ã\83\95ã\82¡がある。
 T}
 Read/Write:T{
 POLLIN|
@@ -118,12 +137,35 @@ T}
 .\" or
 .\" .BR close (2).
 .TE
-
 .PP
 \fBpoll\fP(2)  や \fBselect\fP(2)  を使う代わりに、カーネルからアプリケーションに イベントを通知させるのに \fBSIGIO\fP
 シグナルを使う方法もある。 この方法を使うには、 \fBfcntl\fP(2)  を用いてソケットのファイルディスクリプタに \fBO_ASYNC\fP
 フラグをセットし、 \fBSIGIO\fP に対する有効なシグナルハンドラを \fBsigaction\fP(2)  によって設定しておく必要がある。 後述の
 \fIシグナル\fP に関する議論も参考にすること。
+.SS ソケットアドレス構造体
+各ソケットドメインにはそれぞれ独自のソケットアドレス形式があり、ドメイン固有のアドレス構造体を持っている。
+これらの構造体の先頭には、アドレス構造体の種類を示す整数の "family" フィールド (型は \fIsa_family_t\fP) がある。
+このフィールドにより、 すべてのソケットドメインで汎用的に使用されるシステムコール (例えば、 \fBconnect\fP(2), \fBbind\fP(2),
+\fBaccept\fP(2), \fBgetsockname\fP(2), \fBgetpeername\fP(2) など)
+が、特定のソケットアドレスのドメインを判定することができる。
+
+任意の種類のソケットアドレスをソケット API のインターフェースに渡せるように、 \fIstruct sockaddr\fP 型が定義されている。
+この型の目的は、 純粋に、 ドメイン固有のソケットアドレスを 「汎用的な」型にキャストできるようにする点にある。 これにより、 ソケット API
+呼び出しにおいて、 コンパイラが型の不一致の警告を出すのを避けることができる。
+
+これに加えて、ソケット API ではデータ型 \fIstruct sockaddr_storage\fP が提供されている。
+サポートしているすべてのドメイン固有のソケットアドレス構造体を収容するのに、この型を使うことができる。 この型は十分な大きさがあり、(メモリ境界への)
+アラインも適切に行われている (特に、 IPv6 ソケットアドレスを収容するのにも十分な大きさである)。 この構造体には次のフィールドがあり、
+このフィールドを使って、 この構造体に実際に格納されているソケットアドレスの型を特定することができる。
+
+.in +4n
+.nf
+    sa_family_t ss_family;
+.fi
+.in
+
+\fIsockaddr_storage\fP 構造体は、 ソケットアドレスを汎用的な方法で扱う必要があるプログラム (例えば、 IPv4 と IPv6
+の両方のソケットアドレスを扱う必要があるプログラム) で有用である。
 .SS ソケットオプション
 .\" FIXME
 .\" In the list below, the text used to describe argument types
@@ -132,24 +174,25 @@ T}
 .\" SO_ACCEPTCONN is in POSIX.1-2001, and its origin is explained in
 .\" W R Stevens, UNPv1
 これらのソケットオプションは、 \fBsetsockopt\fP(2)  を用いれば設定でき、 \fBgetsockopt\fP(2)  を用いれば取得できる。
-但し、どのソケットの場合も ソケットレベルには \fBSOL_SOCKET\fP を指定すること。
+但し、どのソケットの場合も ソケットレベルには \fBSOL_SOCKET\fP を指定すること。 注釈がない限り、 \fIoptval\fP は \fIint\fP
+へのポインタである。
 .TP 
 \fBSO_ACCEPTCONN\fP
 このソケットが \fBlisten\fP(2)  によって接続待ち受け状態に設定されているかどうかを示す値を返す。 値 0 は listen
 状態のソケットでないことを、 値 1 は listen 状態のソケットであることを示す。このソケットオプションは読み込み専用である。
 .TP 
 \fBSO_BINDTODEVICE\fP
-このソケットを、引き数で渡したインターフェース名で指定される
-(\(lqeth0\(rq のような) 特定のデバイスにバインドする。
-名前が空文字列だったり、オプションの長さ (optlen) が 0 の場合には、
\82½ã\82±ã\83\83ã\83\88ã\81®ã\83\90ã\82¤ã\83³ã\83\89ã\81\8cå\89\8aé\99¤ã\81\95ã\82\8cã\82\8bã\80\82渡ã\81\99ã\82ªã\83\97ã\82·ã\83§ã\83³ã\81¯ã\80\81ã\82¤ã\83³ã\82¿ã\83¼ã\83\95ã\82§ã\83¼ã\82¹å\90\8dã\81\8c
-入ったヌル文字で終端された可変長の文字列である。
-文字列の最大のサイズは \fBIFNAMSIX\fP である
-ソケットがインターフェースにバインドされると、その特定のインターフェース
-から受信されたパケットだけを処理する。
\81\93ã\81®ã\82ªã\83\97ã\82·ã\83§ã\83³ã\81¯ã\81\84ã\81\8fã\81¤ã\81\8bã\81®ã\82½ã\82±ã\83\83ã\83\88ã\82¿ã\82¤ã\83\97
-特に \fBAF_INET\fP に対してのみ動作する点に注意すること。
-パケットソケットではサポートされていない (通常の \fBbind\fP(2) を使うこと)
+このソケットを、引き数で渡したインターフェース名で指定される (\(lqeth0\(rq のような) 特定のデバイスにバインドする。
+名前が空文字列だったり、オプションの長さ (optlen) が 0 の場合には、 ソケットのバインドが削除される。
+渡すオプションは、インターフェース名が 入ったヌル文字で終端された可変長の文字列である。 文字列の最大のサイズは \fBIFNAMSIX\fP である。
\82½ã\82±ã\83\83ã\83\88ã\81\8cã\82¤ã\83³ã\82¿ã\83¼ã\83\95ã\82§ã\83¼ã\82¹ã\81«ã\83\90ã\82¤ã\83³ã\83\89ã\81\95ã\82\8cã\82\8bã\81¨ã\80\81 ã\81\9dã\81®ç\89¹å®\9aã\81®ã\82¤ã\83³ã\82¿ã\83¼ã\83\95ã\82§ã\83¼ã\82¹ã\81\8bã\82\89å\8f\97ä¿¡ã\81\95ã\82\8cã\81\9fã\83\91ã\82±ã\83\83ã\83\88ã\81 ã\81\91ã\82\92å\87¦ç\90\86ã\81\99ã\82\8bã\80\82
+このオプションはいくつかのソケットタイプ、 特に \fBAF_INET\fP に対してのみ動作する点に注意すること。 パケットソケットではサポートされていない
+(通常の \fBbind\fP(2) を使うこと)
+
+Linux 3.8 より前のバージョンでは、このソケットオプションは \fBgetsockname\fP(2)
\81§è¨­å®\9aã\81\99ã\82\8bã\81\93ã\81¨ã\81¯ã\81§ã\81\8dã\81\9fã\81\8cã\80\81å\8f\96å¾\97ã\81\99ã\82\8bã\81\93ã\81¨ã\81\8cã\81§ã\81\8dã\81ªã\81\8bã\81£ã\81\9fã\80\82 Linux 3.8 ä»¥é\99\8dã\81§ã\81¯ã\80\81読ã\81¿å\87ºã\81\99ã\81\93ã\81¨ã\81\8cã\81§ã\81\8dã\82\8bã\80\82 \fIoptlen\fP å¼\95ã\81\8dæ\95°ã\81«ã\81¯
+デバイス名を格納するのに十分なバッファサイズを渡すべきであり、 \fBIFNAMSIZ\fP バイトにすることを推奨する。 実際のデバイス名の長さは
+\fIoptlen\fP 引き数に格納されて返される
 .TP 
 \fBSO_BROADCAST\fP
 ブロードキャストフラグを設定・取得する。有効になっていると、データグラ
@@ -176,7 +219,7 @@ Linux 2.6 ではプログラムがこのオプションを使用すると (print
 このソケットオプションは読み込み専用である。整数値をとる。
 .TP 
 \fBSO_DONTROUTE\fP
-ゲートウェイを経由せず、直接接続されているホストに送信する。 \fBsend\fP(2)  操作で \fBMSG_DONTROUTE\fP
+ゲートウェイを経由せず、直接接続されているホストにのみ送信する。 \fBsend\fP(2)  操作で \fBMSG_DONTROUTE\fP
 フラグをセットした場合も同じ効果が得られる。 ブール整数のフラグを取る。
 .TP 
 \fBSO_KEEPALIVE\fP
@@ -199,6 +242,13 @@ struct linger {
 これらのコールはただちに戻り、クローズ動作はバックグラウンドで行われる。 ソケットのクローズを \fBexit\fP(2)
 の一部として行った場合には、残っているソケットの クローズ動作は必ずバックグラウンドに送られる。
 .TP 
+\fBSO_MARK\fP (Linux 2.6.25 以降)
+.\" commit 4a19ec5800fc3bb64e2d87c4d9fdd9e636086fe0
+.\" and    914a9ab386a288d0f22252fc268ecbc048cdcbd5
+このソケットから送信される各パケットにマークをセットする (netfilter の MARK ターゲットと似ているが、ソケット単位である点が異なる)。
+マークの変更は、 netfilter なしでのマークに基づいてのルーティングや、 パケットフィルタリングに使うことができる。
+このオプションを変更するには \fBCAP_NET_ADMIN\fP ケーパビリティが必要である。
+.TP 
 \fBSO_OOBINLINE\fP
 .\" don't document it because it can do too much harm.
 .\".B SO_NO_CHECK
@@ -210,15 +260,52 @@ struct linger {
 .\" in the 2.6.18 ChangeLog
 \fBSCM_CREDENTIALS\fP 制御メッセージの受信を有効/無効にする。詳細は \fBunix\fP(7)  を参照のこと。
 .TP 
+\fBSO_PEEK_OFF\fP (Linux 3.4 以降)
+.\" commit ef64a54f6e558155b4f149bb10666b9e914b6c54
+\fBMSG_PEEK\fP フラグと一緒に使用された場合 \fBrecv\fP(2) システムコールの "peek offset"
+にこのオプションの値が設定される。現在のところ、このオプションは \fBunix\fP(7) ソケットでのみサポートされている。
+
+このオプションが負の値に設定された場合、従来の動作となる。 つまり \fBMSG_PEEK\fP フラグが指定された \fBrecv\fP(2)
+は、キューの先頭のデータに対して peek 処理を行う (データを読み出すが、キューからデータの削除を行わない)。
+新規のソケットではこのオプションの値は必ず \-1 に設定される。
+
+このオプションに 0 以上の値が設定されると、 そのソケットのキュー上のオプション値で指定されたバイトオフセットにあるデータが次の peek
+処理で返される。 同時に、 "peek offset" がキューから peek 処理されたバイト数だけ加算される。したがって、次の peek
+処理ではキューのその次にあるデータが返される。
+
+\fBrecv\fP(2) (や同様のシステムコール) の \fBMSG_PEEK\fP フラグなしの呼び出しでキューの先頭のデータが削除された場合、 "peek
+offset" は削除されたバイト数だけ減算される。 言い換えると、 \fBMSG_PEEK\fP フラグなしでデータを受信すると、 "peek
+offset" が指すキュー内の相対的な位置が狂わないように調整され、この後の peek では、
+データ削除が行われなかった場合に返されたのと同じ値が返されるということである。
+
+データグラムソケットでは、 "peek offset" がパケットの途中を指している場合には、 返されるデータには \fBMSG_TRUNC\fP
+フラグが付与される。
+
+以下の例は \fBSO_PEEK_OFF\fP の利用例を示している。ストリームソケットのキューに以下の入力データが入っているものとする。
+
+    aabbccddeeff
+
+.IP
+以下の順序で \fBrecv\fP(2) の呼び出しを行うと、コメントに書かれた結果となる。
+
+.in +4n
+.nf
+int ov = 4;                  // Set peek offset to 4
+setsockopt(fd, SOL_SOCKET, SO_PEEK_OFF, &ov, sizeof(ov));
+
+recv(fd, buf, 2, MSG_PEEK);  // Peeks "cc"; offset set to 6
+recv(fd, buf, 2, MSG_PEEK);  // Peeks "dd"; offset set to 8
+recv(fd, buf, 2, 0);         // Reads "aa"; offset set to 6
+recv(fd, buf, 2, MSG_PEEK);  // Peeks "ee"; offset set to 8
+.fi
+.in
+.TP 
 \fBSO_PEERCRED\fP
-このソケットに接続してきた外部プロセスの信任状 (credential) を返す。
-このソケットオプションが利用できるのは、接続された \fBAF_UNIX\fP ストリームソケット間、
-および \fBsocketpair\fP(2) を使って作成された \fBAF_UNIX\fP のストリームソケットと
-データグラムソケットのペアだけである。
-\fBunix\fP(7)  を参照のこと。
-\fBconnect\fP(2) や \fBsocketpair\fP(2) が呼ばれた時に有効であった信任状が返される。
-引き数は \fIucred\fP 構造体である。
-このソケットオプションは読み込み専用である。
+このソケットに接続してきた外部プロセスの信任状 (credential) を返す。このソケットオプションが利用できるのは、接続された
+\fBAF_UNIX\fP ストリームソケット間、および \fBsocketpair\fP(2) を使って作成された \fBAF_UNIX\fP
+のストリームソケットとデータグラムソケットのペアだけである。 \fBunix\fP(7)  を参照のこと。 \fBconnect\fP(2) や
+\fBsocketpair\fP(2) が呼ばれた時に有効であった信任状が返される。引き数は \fIucred\fP
+構造体である。このソケットオプションは読み込み専用である。
 .TP 
 \fBSO_PRIORITY\fP
 プロトコルで定義された優先度を、このソケットから 送信される全てのパケットにセットする。 Linux はネットワークキュー内部の
@@ -232,6 +319,10 @@ struct linger {
 .TP 
 \fBSO_RCVBUF\fP
 .\" Most (all?) other implementations do not do this -- MTK, Dec 05
+.\" The following thread on LMKL is quite informative:
+.\" getsockopt/setsockopt with SO_RCVBUF and SO_SNDBUF "non-standard" behaviour
+.\" 17 July 2012
+.\" http://thread.gmane.org/gmane.linux.kernel/1328935
 ソケットの受信バッファの最大サイズを設定・取得する (バイト単位)。 \fBsetsockopt\fP(2)  を使って値が設定されたときに
 (管理オーバヘッド用の領域を確保するために)  カーネルはこの値を 2倍し、 \fBgetsockopt\fP(2)  はこの 2倍された値を返す。
 デフォルトの値は \fI/proc/sys/net/core/rmem_default\fP ファイルで設定され、許容される最大の値は
@@ -259,11 +350,11 @@ struct linger {
 .\" in fact to EAGAIN
 送信・受信のタイムアウトを指定する。これを越えるとエラーを報告する。 引き数は \fIstruct timeval\fP である。
 入出力関数がタイムアウト時間の間ブロックされ、かつデータの送信または 受信が行われていた場合は、転送されたデータ量が関数の返り値となる。
-何もデータが転送されずにタイムアウトに達した場合は、 \-1 を返し、 \fIerrno\fP に \fBEAGAIN\fP か \fBEWOULDBLOCK\fP
-を設定され、 あたかもソケットに非ブロッキングが指定されたように見える。 タイムアウト値に (デフォルト値である) 0 に設定すると、
-操作は決してタイムアウトしなくなる。 タイムアウトが影響を及ぼすのは、 ソケット I/O を実行するシステムコールだけ (例えば \fBread\fP(2),
-\fBrecvmsg\fP(2), \fBsend\fP(2), \fBsendmsg\fP(2))  である。 \fBselect\fP(2), \fBpoll\fP(2),
-\fBepoll_wait\fP(2)  などにはタイムアウトは影響を及ぼさない。
+何もデータが転送されずにタイムアウトに達した場合は、 \-1 を返し、 \fIerrno\fP に \fBEAGAIN\fP か \fBEWOULDBLOCK\fP か
+\fBEINPROGRESS\fP (\fBconnect\fP(2) の場合) が設定され、 あたかもソケットに非ブロッキングが指定されたように見える。
+タイムアウト値に (デフォルト値である) 0 に設定すると、 操作は決してタイムアウトしなくなる。 タイムアウトが影響を及ぼすのは、 ソケット I/O
+を実行するシステムコールだけ (例えば \fBread\fP(2), \fBrecvmsg\fP(2), \fBsend\fP(2), \fBsendmsg\fP(2))
+である。 \fBselect\fP(2), \fBpoll\fP(2), \fBepoll_wait\fP(2)  などにはタイムアウトは影響を及ぼさない。
 .TP 
 \fBSO_REUSEADDR\fP
 \fBbind\fP(2)  コールに与えられたアドレスが正しいかを判断するルールで、 ローカルアドレスの再利用を可能にする。 つまり \fBAF_INET\fP
@@ -273,6 +364,7 @@ struct linger {
 .TP 
 \fBSO_SNDBUF\fP
 .\" Most (all?) other implementations do not do this -- MTK, Dec 05
+.\" See also the comment to SO_RCVBUF (17 Jul 2012 LKML mail)
 ソケットの送信バッファの最大サイズを設定・取得する (バイト単位)。 \fBsetsockopt\fP(2)  を使って値が設定されたときに
 (管理オーバヘッド用の領域を確保するために)  カーネルはこの値を 2倍し、 \fBgetsockopt\fP(2)  はこの 2倍された値を返す。
 デフォルトの値は \fI/proc/sys/net/core/wmem_default\fP ファイルで設定され、許容される最大の値は
@@ -302,7 +394,7 @@ struct linger {
 リアルタイムシグナルのハンドラは、 \fIsiginfo_t\fP の \fIsi_fd\fP フィールドにファイルディスクリプタが入った状態で呼び出される。
 詳細は \fBfcntl\fP(2)  を参照のこと。
 .PP
-.\" .SS Ancillary Messages
+.\" .SS Ancillary messages
 状況によっては (例えば複数のプロセスが一つのソケットにアクセスしているなど)、 \fBSIGIO\fP
 の原因となった状態は、プロセスがそのシグナルへの対応を行ったときには 消えてしまっているかもしれない。
 この場合は、プロセスは再び待つようにすべきである。 Linux は同じシグナルを後で再送するからである。
@@ -390,9 +482,10 @@ Linux では、 \fBSO_REUSEADDR\fP オプションでポートの再利用が許
 \fBCONFIG_FILTER\fP ソケットオプションである \fBSO_ATTACH_FILTER\fP と \fBSO_DETACH_FILTER\fP
 について記載されていない。これらは libpcap ライブラリを通して 用いる方が良い。
 .SH 関連項目
-\fBgetsockopt\fP(2), \fBsetsockopt\fP(2), \fBsocket\fP(2), \fBcapabilities\fP(7),
-\fBddp\fP(7), \fBip\fP(7), \fBpacket\fP(7), \fBtcp\fP(7), \fBudp\fP(7), \fBunix\fP(7)
+\fBgetsockopt\fP(2), \fBconnect\fP(2), \fBsetsockopt\fP(2), \fBsocket\fP(2),
+\fBcapabilities\fP(7), \fBddp\fP(7), \fBip\fP(7), \fBpacket\fP(7), \fBtcp\fP(7), \fBudp\fP(7),
+\fBunix\fP(7)
 .SH この文書について
-この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.41 の一部
+この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 である。プロジェクトの説明とバグ報告に関する情報は
 http://www.kernel.org/doc/man\-pages/ に書かれている。