1 .\" This man page is Copyright (C) 1999 Andi Kleen <ak@muc.de>.
3 .\" %%%LICENSE_START(VERBATIM_ONE_PARA)
4 .\" Permission is granted to distribute possibly modified copies
5 .\" of this page provided the header is included verbatim,
6 .\" and in case of nontrivial modification author and date
7 .\" of the modification is added to the header.
10 .\" $Id: udp.7,v 1.7 2000/01/22 01:55:05 freitag Exp $
12 .\"*******************************************************************
14 .\" This file was generated with po4a. Translate the source file.
16 .\"*******************************************************************
17 .TH UDP 7 2010\-06\-13 Linux "Linux Programmer's Manual"
19 udp \- IPv4 の ユーザーデータグラムプロトコル
21 \fB#include <sys/socket.h>\fP
23 \fB#include <netinet/in.h>\fP
25 \fBudp_socket = socket(AF_INET, SOCK_DGRAM, 0);\fP
27 これは RFC\ 768 で記述されている User Datagram Protocol の実装である。 UDP
28 はコネクションレスの、信頼性の低いデータパケットサービスである。 パケットは到着前に並び替えられたり複製されたりする。 UDP
29 は転送エラーを検出するためにチェックサムを生成・チェックする。
31 UDP ソケットが生成されるとき、 ローカルアドレスやリモートアドレスは指定されない。 正しい行き先アドレスを引数として \fBsendto\fP(2) や
32 \fBsendmsg\fP(2) を呼べば、データグラムはただちに送信される。 ソケットに対して \fBconnect\fP(2)
33 を呼ぶと、デフォルトの行き先アドレスが設定され、 \fBsend\fP(2) や \fBwrite\fP(2)
34 を使って、行き先アドレスの指定なしにデータグラムを送信できるようになる。 この場合でも、行き先アドレスを \fBsendto\fP(2) や
35 \fBsendmsg\fP(2) に渡せば、デフォルト以外のアドレスに送信可能である。 パケットを受信するために、まずソケットを \fBbind\fP(2)
36 を用いてローカルなアドレスにバインドさせることもできる。 そうでない場合は、ソケット層は自動的に
37 \fI/proc/sys/net/ipv4/ip_local_port_range\fP で定義されている範囲の外で空いているローカルなポートを割り当て、
38 ソケットを \fBINADDR_ANY\fP にバインドする。
40 受信動作はパケットを一つだけ返す。渡したバッファよりもパケットが 小さければ、そのパケットの大きさのデータだけが返される。
41 逆にバッファよりも大きい場合はパケットは丸められ、 \fBMSG_TRUNC\fP フラグがセットされる。 \fBMSG_WAITALL\fP
44 IP オプションは、 \fBip\fP(7) に記述されているソケットオプションを用いて読み書きできる。 これらは適切な \fI/proc\fP
45 パラメータが有効な場合に限ってカーネルによって処理される (しかし無効になっている場合でもユーザーには渡される)。 \fBip\fP(7) を参照のこと。
47 \fBMSG_DONTROUTE\fP フラグが送信時にセットされている場合には、 行き先アドレスはローカルなインターフェースアドレスから
48 参照できなければならない。パケットはそのインターフェースにしか送られない。
50 デフォルトでは、Linux の UDP は Path MTU Discovery を行う。 つまり、カーネルは特定の宛先 IP アドレスの MTU
51 (Maximum Transmission Unit; 最大転送単位) を記録し、UDP パケットの書き込みが MTU を超えた場合
52 \fBEMSGSIZE\fP を返す。 \fBEMSGSIZE\fP を返された場合、アプリケーションはパケットサイズを小さくすべきである。 ソケットオプション
53 \fBIP_MTU_DISCOVER\fP または \fI/proc/sys/net/ipv4/ip_no_pmtu_disc\fP ファイルを使って Path
54 MTU Discovery を無効にすることもできる (詳細は \fBip\fP(7) を参照)。 Path MTU Discovery
55 を無効にした場合は、パケットサイズが インタフェースの MTU よりも大きいと UDP はそのパケットを フラグメント化して送出する。
56 しかしながら、性能と信頼性の理由から Path MTU Discovery を 無効にするのは推奨できない。
58 UDP は IPv4 の \fIsockaddr_in\fP アドレスフォーマットを用いる。これは \fBip\fP(7) に記述されている。
60 致命的なエラーは、たとえソケットが接続されていなくても、 すべてエラー戻り値としてユーザーに渡される。
61 これにはネットワークから受け取る非同期エラーも含まれる。 同じソケットを使って送信した昔のパケットに関するエラーを受け取るかもしれない。
62 この振る舞いは他の BSD ソケットの実装の多くとは異なる。 これらではソケットが接続されていない場合はエラーを全く返さない。 Linux の振る舞いは
63 \fBRFC\ 1122\fP での指定に従ったものである。
65 Linux 2.0 と 2.2 では、古いコードとの互換性のために、 \fBSO_BSDCOMPAT\fP \fBSOL_SOCKET\fP
66 オプションを設定すれば、ソケットが接続されている 場合に限ってリモートのエラーを受信するようにできた (\fBEPROTO\fP と \fBEMSGSIZE\fP
67 を除く)。 ローカルで生成されたエラーは常に渡される。 このソケットオプションのサポートはそれ以降のバージョンの Linux で 削除された。詳細は
70 \fBIP_RECVERR\fP オプションが有効になっていると、 すべてのエラーはソケットのエラーキューに保存される。 これは
71 \fBMSG_ERRQUEUE\fP フラグをセットして \fBrecvmsg\fP(2) を呼べば受信できる。
73 システム全体の UDP パラメータ設定には、 \fI/proc/sys/net/ipv4/\fP ディレクトリ内のファイルの読み書きでアクセスできる。
75 \fIudp_mem\fP (Linux 2.6.25 以降)
76 これは 3 つの整数からなるベクトル値で、 UDP の全ソケットのキューで利用可能なページ数を制御する。
80 このページ数より少なければ、UDP はそのメモリ使用に関して 干渉されない。 UDP に割り当てられたメモリ総量がこの値を超過すると、 UDP
84 この値は \fItcp_mem\fP の形式 (\fBtcp\fP(7) 参照) と合わせるために導入された
87 UDP の全ソケットのキューで利用可能なページ数。
90 これらの 3 つの値のデフォルト値は、 ブート時に利用可能なメモリ総量から計算される。
92 \fIudp_rmem_min\fP (integer; デフォルト値: PAGE_SIZE; Linux 2.6.25 以降)
93 メモリ使用量の調整中に、UDP ソケットが使用できる受信バッファの最小値 (バイト単位)。 UDP の全ソケットのページ使用量の合計が
94 \fIudp_mem\fP pressure を超過している場合であっても、 各 UDP ソケットはデータの受信にこのサイズ分だけは使用することができる。
96 \fIudp_wmem_min\fP (integer; デフォルト値: PAGE_SIZE; Linux 2.6.25 以降)
97 メモリ使用量の調整中に、UDP ソケットが使用できる送信バッファの最小値 (バイト単位)。 UDP の全ソケットのページ使用量の合計が
98 \fIudp_mem\fP pressure を超過している場合であっても、 各 UDP ソケットはデータの送信にこのサイズ分だけは使用することができる。
100 UDP ソケットオプションを設定または取得するには、 取得には \fBgetsockopt\fP(2) を、設定には \fBsetsockopt\fP(2)
101 をオプションレベル引数に \fBIPPROTO_UDP\fP を指定して呼び出す。
103 \fBUDP_CORK\fP (Linux 2.5.44 以降)
104 .\" FIXME document UDP_ENCAP (new in kernel 2.5.67)
105 .\" From include/linux/udp.h:
106 .\" /* UDP encapsulation types */
107 .\" #define UDP_ENCAP_ESPINUDP_NON_IKE 1 /* draft-ietf-ipsec-nat-t-ike-00/01 */
108 .\" #define UDP_ENCAP_ESPINUDP 2 /* draft-ietf-ipsec-udp-encaps-06 */
109 .\" #define UDP_ENCAP_L2TPINUDP 3 /* rfc2661 */
110 このオプションが指定されると、このソケットの全てのデータ出力は 一つのデータグラムに蓄積され、このオプションが無効化された時に 送信される。
111 このオプションは移植性を考慮したコードでは用いるべきではない。
113 以下に示す ioctl は \fBioctl\fP(2) を使ってアクセスできる。 正しい文法は以下の通り。
117 \fBint\fP\fI value\fP\fB;\fP
118 \fIerror\fP\fB = ioctl(\fP\fIudp_socket\fP\fB, \fP\fIioctl_type\fP\fB, &\fP\fIvalue\fP\fB);\fP
122 \fBFIONREAD\fP (\fBSIOCINQ\fP)
123 .\" See http://www.securiteam.com/unixfocus/5KP0I15IKO.html
124 .\" "GNUnet DoS (UDP Socket Unreachable)", 14 May 2006
125 整数へのポインタを引き数に取り、そのポインタに、次の処理待ちのデータグラムの
126 サイズをバイト単位で返す。処理待ちのデータグラムがない場合は 0 を返す。
127 \fB警告\fP: \fBFIONREAD\fP を使った場合、処理待ちのデータグラムがない場合と、
128 次の処理待ちデータグラムが 0 バイトのデータの場合を区別することができない。
129 この両者を区別したい場合は、\fBselect\fP(2), \fBpoll\fP(2), \fBepoll\fP(7)
132 \fBTIOCOUTQ\fP (\fBSIOCOUTQ\fP)
133 ローカル送信キューにあるデータサイズをバイト単位で返す。 Linux 2.4 以上でのみ対応している。
135 さらに、 \fBip\fP(7) と \fBsocket\fP(7) で述べられている全ての ioctl も対応している。
137 \fBsocket\fP(7) や \fBip\fP(7) に記述されている全てのエラーが、 UDP ソケットの送受信で返される可能性がある。
140 行き先アドレスに関連づけられている受信者がいない。 これは以前のパケットがそのパケットを 上書き送信してしまっているからであることが多い。
143 .\" This man page was written by Andi Kleen.
144 \fBIP_RECVERR\fP は Linux 2.2 の新しい機能である。
146 \fBip\fP(7), \fBraw\fP(7), \fBsocket\fP(7), \fBudplite\fP(7)
148 RFC\ 768 : User Datagram Protocol
152 RFC\ 1191 : path MTU discovery の記述
154 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.51 の一部
155 である。プロジェクトの説明とバグ報告に関する情報は
156 http://www.kernel.org/doc/man\-pages/ に書かれている。