draft/man7/ip.7

   1 .\" t
   2 .\" Don't change the line above. it tells man that tbl is needed.
   3 .\" This man page is Copyright (C) 1999 Andi Kleen <ak@muc.de>.
   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.
   8 .\" $Id: ip.7,v 1.19 2000/12/20 18:10:31 ak Exp $
   9 .\"
  10 .\" FIXME: Document IP_MINTTL, added in Linux 2.6.34
  11 .\"
  12 .\"*******************************************************************
  13 .\"
  14 .\" This file was generated with po4a. Translate the source file.
  15 .\"
  16 .\"*******************************************************************
  17 .TH IP 7 2011\-09\-22 Linux "Linux Programmer's Manual"
  18 .SH 名前
  19 ip \- Linux IPv4 プロトコルの実装
  20 .SH 書式
  21 \fB#include <sys/socket.h>\fP
  22 .br
  23 .\" .B #include <net/netinet.h> -- does not exist anymore
  24 .\" .B #include <linux/errqueue.h> -- never include <linux/foo.h>
  25 \fB#include <netinet/in.h>\fP
  26 .br
  27 \fB#include <netinet/ip.h> \fP/* 上記のスーパーセット */
  28 .sp
  29 \fItcp_socket\fP\fB = socket(AF_INET, SOCK_STREAM, 0);\fP
  30 .br
  31 \fIudp_socket\fP\fB = socket(AF_INET, SOCK_DGRAM, 0);\fP
  32 .br
  33 \fIraw_socket\fP\fB = socket(AF_INET, SOCK_RAW, \fP\fIprotocol\fP\fB);\fP
  34 .SH 説明
  35 .\" FIXME has someone verified that 2.1 is really 1812 compliant?
  36 Linux は RFC\ 791 と RFC\ 1122 で記述されている Internet Protocol, version 4 を実装している。
  37 \fBip\fP には RFC\ 1112 に準拠した level 2 マルチキャストの実装が含まれている。 またパケットフィルタ機能を含む IP
  38 ルーターも実装されている。
  39 .PP
  40 プログラミング・インターフェースは BSD ソケットと互換である。 ソケットに関するより詳細な情報は \fBsocket\fP(7)  を参照のこと。
  41 .PP
  42 IP ソケットは、 \fBsocket\fP(2) 関数を \fBsocket(AF_INET, \fP\fIsocket_type\fP\fB, \fP
  43 \fIprotocol\fP\fB)\fP のように呼び出すことで生成される。指定できるソケットタイプは
  44 3 つあり、 \fBtcp\fP(7) ソケットをオープンする場合 \fBSOCK_STREAM\fP、 \fBudp\fP(7)
  45 ソケットをオープンする場合 \fBSOCK_DGRAM\fP、 IP プロトコルに直接アクセスする
  46 ために \fBraw\fP(7) ソケットをオープンする場合には \fBSOCK_RAW\fP である。
  47 \fIprotocol\fP は送受信される IP ヘッダに書かれる IP プロトコルである。
  48 指定できる値は、 TCP ソケットには 0 か \fBIPPROTO_TCP\fP、 UDP ソケットには
  49 0 か \fBIPPROTO_UDP\fP に限られる。 \fBSOCK_RAW\fP に対しては、 RFC\ 1700 で定義
  50 されている有効な IANA IP プロトコルを、 割り当てられている番号で指定する
  51 ことができる。
  52 .PP
  53 .\" FIXME ip current does an autobind in listen, but I'm not sure
  54 .\" if that should be documented.
  55 あるプロセスで、やってくるパケットを受信したり 接続要求を受けたりしたい場合には、 そのプロセスはローカルなインターフェースアドレスに、
  56 \fBbind\fP(2)  を用いてソケットをバインドしなければならない。 あるローカルな「アドレスとポート」のペアに対してバインドできる IP
  57 ソケットは一つに限られる。 \fBbind\fP(2)  の呼び出しで \fBINADDR_ANY\fP
  58 が指定されていた場合は、ソケットはローカルなインターフェースの \fIすべて\fPにバインドされる。 \fBlisten\fP(2)  または
  59 \fBconnect\fP(2)  がバインドされていないソケットでコールされると、 そのソケットは自動的にローカルなアドレスを \fBINADDR_ANY\fP
  60 にセットし、空いているポートをランダムに選んでバインドする。
  61
  62 \fBSO_REUSEADDR\fP フラグがセットされていない場合には、 バインドされていた TCP ローカルソケットアドレスは
  63 クローズされた後しばらくの間使えなくなる。 \fBSO_REUSEADDR\fP フラグを使うと TCP の信頼性を低下させるので、
  64 使うときには注意が必要である。
  65 .SS アドレスのフォーマット
  66 IP ソケットアドレスは、 IP インターフェースアドレスと 16ビットのポート番号の組み合わせで定義される。 IP
  67 プロトコルそのものはポート番号を扱わない。 ポート番号は、 \fBudp\fP(7)  や \fBtcp\fP(7)  といった、上位のプロトコルで実装される。
  68 raw ソケットでは、 \fIsin_port\fP が IP プロトコルにセットされる。
  69 .PP
  70 .in +4n
  71 .nf
  72 struct sockaddr_in {
  73     sa_family_t    sin_family; /* address family: AF_INET */
  74     in_port_t      sin_port;   /* port in network byte order */
  75     struct in_addr sin_addr;   /* internet address */
  76 };
  77
  78 /* Internet address. */
  79 struct in_addr {
  80     uint32_t       s_addr;     /* address in network byte order */
  81 };
  82 .fi
  83 .in
  84 .PP
  85 \fIsin_familiy\fP には常に \fBAF_INET\fP をセットする。これは必須である。 Linux 2.2 では、このセットを忘れると
  86 ほとんどのネットワーク関数は \fBEINVAL\fP を返すようになっている。 \fIsin_port\fP
  87 にはポート番号をネットワークバイトオーダーで指定する。 1024 未満のポート番号は \fI特権ポート (privileged ports)\fP と呼ばれる
  88 (\fI予約ポート (reserved ports)\fP とも時々呼ばれる)。 特権プロセス (\fBCAP_NET_BIND_SERVICE\fP
  89 ケーパビリティを持つプロセス) 以外のプロセスは、これらのポートには \fBbind\fP(2)  できない。 IPv4
  90 プロトコルそのものにはポートに関する概念がない。 ポートは、 \fBtcp\fP(7)  や \fBudp\fP(7)
  91 といった、上位のプロトコルにおいて実装される。
  92 .PP
  93 \fIsin_addr\fP は IP ホストアドレスである。 \fIstruct in_addr\fP の \fIs_addr\fP
  94 メンバには、ホストのインターフェースアドレスを ネットワークバイトオーダーで
  95 指定する。 \fIin_addr\fP は、\fBINADDR_*\fP の一つ (例えば \fBINADDR_ANY\fP) を代入する、
  96 ライブラリ関数 \fBinet_aton\fP(3), \fBinet_addr\fP(3), \fBinet_makeaddr\fP(3) を用いる、
  97 あるいは名前解決機構 (name resolver) を直接用いる、のどれかで設定すべきである。
  98 (\fBgethostbyname\fP(3) を見よ)。
  99
 100 .\" Leave a loophole for XTP @)
 101 IPv4 アドレスには、ユニキャストアドレス、 ブロードキャストアドレス、マルチキャストアドレスがある。
 102 ユニキャストアドレスは、あるホストの一つのアドレスを指定する。 ブロードキャストアドレスは、あるネットワーク上の全てのホストを指定する。
 103 マルチキャストアドレスは、マルチキャストグループに所属する 全てのホストを指定する。ブロードキャストアドレスへのデータグラムは、
 104 \fBSO_BROADCAST\fP ソケットフラグがセットされていないと送信・受信できない。
 105 現在の実装では、接続指向のソケットにはユニキャストアドレスしか使えない。
 106
 107 アドレスとポートは常にネットワークバイトオーダーで格納されることに注意せよ。 具体的には、ポートを指定する数値には \fBhtons\fP(3)
 108 を呼び出す必要がある。 標準ライブラリにあるアドレス/ポート操作関数は すべてネットワークバイトオーダーで動作する。
 109
 110 特別なアドレスがいくつか存在する: \fBINADDR_LOOPBACK\fP(127.0.0.1)  は loopback
 111 デバイスを通して常にローカルなホストを参照する。 \fBINADDR_ANY\fP(0.0.0.0)  は任意のアドレスを意味し、バインド用である。
 112 \fBINADDR_BROADCAST\fP(255.255.255.255)  は任意のホストを意味し、歴史的理由から、バインドの際には
 113 \fBINADDR_ANY\fP と同じ効果になる。
 114 .SS ソケットオプション
 115 .\" or SOL_IP on Linux
 116 IP にはプロトコル固有のソケットオプションがいくつか存在し、 \fBsetsockopt\fP(2)  で設定が、 \fBgetsockopt\fP(2)
 117 で取得ができる。 IP のソケットオプションレベルは \fBIPPROTO_IP\fP である。 ブール整数値のフラグでは、 0
 118 は偽、それ以外は真を意味する。
 119 .TP
 120 \fBIP_ADD_MEMBERSHIP\fP (Linux 1.2 以降)
 121 マルチキャストグループに参加する。 引き数は \fIip_mreqn\fP 構造体である。
 122 .sp
 123 .in +4n
 124 .nf
 125 struct ip_mreqn {
 126     struct in_addr imr_multiaddr; /* IP multicast group
 127                                      address */
 128     struct in_addr imr_address;   /* IP address of local
 129                                      interface */
 130     int            imr_ifindex;   /* interface index */
 131 };
 132 .fi
 133 .in
 134 .sp
 135 .\" (i.e., within the 224.0.0.0-239.255.255.255 range)
 136 \fIimr_multiaddr\fP には、アプリケーションが参加または撤退したい マルチキャストグループのアドレスが入る。
 137 指定するアドレスは有効なマルチキャストアドレスでなければならない (さもなければ \fBsetsockopt\fP(2)  がエラー \fBEINVAL\fP
 138 で失敗する)。 \fIimr_address\fP はシステムがマルチキャストグループに参加する際に用いる ローカルなインターフェースのアドレスである。
 139 これが \fBINADDR_ANY\fP であった場合には、適切なインターフェースがシステムによって選択される。 \fIimr_ifindex\fP は
 140 \fIimr_multiaddr\fP グループに参加/撤退するインターフェースの interface index である。
 141 どのインターフェースでもよい場合は 0 にする。
 142 .IP
 143 .\"
 144 \fIip_mreqn\fP 構造体は Linux 2.2 以降でのみ利用可能である。互換性のため、
 145 古い \fIip_mreq\fP 構造体 (Linux 1.2 以降で存在する) もまだサポートされている。
 146 \fIip_mreqn\fP との違いは、 \fIimr_ifindex\fP フィールドを含まないことだけである。
 147 \fBsetsockopt\fP(2) でのみ使える。
 148 .TP
 149 \fBIP_DROP_MEMBERSHIP\fP (Linux 1.2 以降)
 150 マルチキャストグループから抜ける。引き数は \fBIP_ADD_MEMBERSHIP\fP と同様に \fIip_mreqn\fP または \fIip_mreq\fP
 151 構造体である。
 152 .TP
 153 \fBIP_FREEBIND\fP (Linux 2.4 以降)
 154 .\" Precisely: 2.4.0-test10
 155 このブール値のオプションを有効にすると、ローカルではない IP アドレスや存在
 156 しない IP アドレスをバインドできるようになる。これを使うと、対応するネット
 157 ワークインターフェイスがなかったり、アプリケーションがソケットをバインドしようと
 158 する時点で特定の動的 IP アドレスが有効になっていなかったりしても、ソケットを
 159 接続待ち状態 (listening) にできるようになる。
 160 このオプションは、下記に説明がある \fIip_nonlocal_bind\fP \fI/proc\fP インターフェイス
 161 のソケット単位の設定である。
 162 .TP
 163 \fBIP_HDRINCL\fP (Linux 2.0 以降)
 164 .\"
 165 .\" FIXME Document IP_IPSEC_POLICY
 166 .\" Since Linux 2.5.47
 167 .\" Needs CAP_NET_ADMIN
 168 有効になっていると、ユーザは IP ヘッダをユーザーデータの前に与える。 \fBSOCK_RAW\fP ソケットでのみ有効である。詳細は \fBraw\fP(7)
 169 を見よ。このフラグが有効になっていると、 \fBIP_OPTIONS\fP, \fBIP_TTL\fP, \fBIP_TOS\fP は無視される。
 170 .TP
 171 \fBIP_MTU\fP (Linux 2.2 以降)
 172 .\" Precisely: 2.1.124
 173 ソケットの、既知の path MTU を取得する。 ソケットが接続している場合のみ有効である。 \fBgetsockopt\fP(2)  でのみ使える。
 174 .TP
 175 \fBIP_MTU_DISCOVER\fP (Linux 2.2 以降)
 176 .\" Precisely: 2.1.124
 177 ソケットの Path MTU Discovery の設定をセット・取得する。
 178 有効になっていると、Linux は \fBSOCK_STREAM\fP ソケットに対して
 179 RFC\ 1191 で定義されている Path MTU Discovery を行う。
 180 \fBSOCK_STREAM\fP でないソケットについては、 \fBIP_PMTUDISC_DO\fP をセットすると、
 181 全ての送信パケットでフラグメント不許可フラグ (don't\-fragment flag) が必ず
 182 セットされるようになる。 \fBSOCK_STREAM\fP でないソケットでは、
 183 パケットを MTU のサイズの塊に分割したり、必要に応じて再送したりするのは、
 184 ユーザが責任を持って行う必要がある。
 185 既知の Path MTU よりも大きなデータグラムの送信が要求されると、
 186 カーネルは (\fBEMSGSIZE\fP で) 送信を拒否する。
 187 \fBIP_PMTUDISC_WANT\fP の場合は、 Path MTU に基づいて必要であればデータグラム
 188 の分割が行われ、それ以外の場合はフラグメント不許可フラグがセットされる。
 189
 190 システム全体のデフォルトは \fBIP_PMTUDISC_WANT\fP と \fBIP_PMTUDISC_DONT\fP の
 191 どちらかに設定することができる。設定の変更は、
 192 \fI/proc/sys/net/ipv4/ip_no_pmtu_disc\fP ファイルに、0 (\fBIP_PMTUDISC_WANT\fP) か
 193 0 以外 (\fBIP_PMTUDISC_DONT\fP) を書き込むことで行う。
 194
 195 .TS
 196 tab(:);
 197 c l
 198 l l.
 199 Path MTU discovery 値:意味
 200 IP_PMTUDISC_WANT:ルートごとの設定を用いる。
 201 IP_PMTUDISC_DONT:Path MTU Discovery を行わない。
 202 IP_PMTUDISC_DO:常に Path MTU Discovery を行う。
 203 IP_PMTUDISC_PROBE:DFビットをセットするが、Path MTU を無視する。
 204 .TE
 205
 206 path MTU discovery が有効になっていると、カーネルは宛先ホストごとに 自動的に
 207 path MTU を処理する。特定の相手に \fBconnect\fP(2) で接続した場合には、
 208 \fBIP_MTU\fP ソケットオプションを用いれば、既知の path MTU の取得に便利である
 209 (たとえば \fBEMSGSIZE\fP エラーが起きた後など)。 path MTU は時間とともに変化する
 210 かもしれない。 宛先がたくさんあるコネクションレスなソケットでは、 与えられた
 211 宛先に対する新しい MTU にも、 エラーキューを用いてアクセスすることができる
 212 (\fBIP_RECVERR\fP を見よ)。 MTU 更新が到着するごとに、新たなエラーがキューイング
 213 される。
 214
 215 MTU discovery の進行中には、データグラムソケットからの初期パケットは 到着しないかもしれない。 UDP を用いるアプリケーションでは、
 216 このことを気にかけておき、 パケットの再送アルゴリズムにこの分を除外させるべきである。
 217
 218 .\" FIXME this is an ugly hack
 219 接続していないソケットに対して path MTU discovery プロセスを立ち上げるには、 大きなデータグラムサイズ (最大 64K
 220 ヘッダバイト長) からはじめて、 path MTU が更新されるまでサイズを縮めていくことも可能である。
 221
 222 path MTU の値をまず見積もってみるには、宛先アドレスに \fBconnect\fP(2)  を使ってデータグラムソケットを接続し、
 223 \fBgetsockopt\fP(2)  を \fBIP_MTU\fP オプションとともに呼び、 MTU を取得することである。
 224
 225 \fBIP_PMTUDISC_PROBE\fP (Linux 2.6.22 以降で利用可能) を設定することで、 \fBSOCK_DGRAM\fP や
 226 \fBSOCK_RAW\fP のソケットで RFC 4821 の MTU 探索を実装することが可能である。 また、この機能は、 \fBtracepath\fP(8)
 227 のような診断ツールで特に有用である。これらのツールでは、 観測された Path MTU よりも大きな探索パケットを意図的に 送信しようとする。
 228 .TP
 229 \fBIP_MULTICAST_IF\fP (Linux 1.2 以降)
 230 ローカルデバイスをマルチキャストソケットとして設定する。引き数は \fBIP_ADD_MEMBERSHIP\fP と同様に \fIip_mreqn\fP または
 231 \fIip_mreq\fP 構造体である。
 232 .IP
 233 不正なソケットオプションが渡されると、 \fBENOPROTOOPT\fP が返される。
 234 .TP
 235 \fBIP_MULTICAST_LOOP\fP (Linux 1.2 以降)
 236 マルチキャストパケットをローカルなソケットにループバックするかどうかを 定めるブール値の整数引き数を設定・取得する。
 237 .TP
 238 \fBIP_MULTICAST_TTL\fP (Linux 1.2 以降)
 239 このソケットから発信されるマルチキャストパケットの time\-to\-live 値を設定・取得する。 マルチキャストパケットに対しては、できるだけ小さな
 240 TTL に設定することがとても重要である。デフォルトは 1 で、 ユーザープログラムが明示的に要求しない限り
 241 マルチキャストパケットはローカルなネットワークから出ないことになる。 引き数に整数を取る。
 242 .TP
 243 \fBIP_NODEFRAG\fP (Linux 2.6.36 以降)
 244 有効 (引き数が 0 以外の場合) になっていると、netfilter 層での出力パケットの
 245 再構築 (reassembly) が行われなくなる。このオプションは \fBSOCK_RAW\fP ソケット
 246 においてのみ有効である。引き数は整数である。
 247 .TP
 248 \fBIP_OPTIONS\fP (Linux 2.0 以降)
 249 .\" Precisely: 1.3.30
 250 .\" FIXME Document IP_PASSSEC
 251 .\" Boolean
 252 .\" Since Linux 2.6.17
 253 .\" commit 2c7946a7bf45ae86736ab3b43d0085e43947945c
 254 .\" Author: Catherine Zhang <cxzhang@watson.ibm.com>
 255 このソケットから送られるパケット全てに付随する IP オプションを 設定・取得する。オプションを保存しているメモリバッファへのポインタと
 256 オプションの長さとを引き数に取る。 \fBsetsockopt\fP(2)  を呼び出すと、ソケットに関連づけられる IP オプションを設定できる。 IPv4
 257 におけるオプションのサイズの最大値は 40 バイトである。 用いることのできるオプションについては RFC\ 791 を見よ。
 258 \fBSOCK_STREAM\fP ソケットに対する初期接続要求パケットに IP オプションが含まれていると、
 259 ルーティングヘッダを付けて戻されてくる初期パケットの IP オプションに同じオプションがセットされる。接続が確立された後、
 260 やってきたパケットのオプションを変更することはできない。 デフォルトでは。外部から受信したパケットの全ての source routing オプション
 261 の処理は無効となっており、 \fI/proc\fP インタフェースの \fIaccept_source_route\fP
 262 を使うとこれを有効にできる。これを無効にしていても timestamps など の他のオプションの処理は行われる。データグラムソケットでは、 IP
 263 オプションはローカルユーザーしか設定できない。 \fBgetsockopt\fP(2)  を \fBIP_OPTIONS\fP
 264 をつけて呼ぶと、現在送信に用いられている IP オプションを 引き数に与えたバッファに取得できる。
 265 .TP
 266 \fBIP_PKTINFO\fP (Linux 2.2 以降)
 267 .\" Precisely: 2.1.68
 268 \fBIP_PKTINFO\fP 補助メッセージを渡す。これには到着パケットに関する情報を提供する \fIpktinfo\fP 構造体が含まれている。
 269 データグラム指向のソケットでしか動作しない。 引き数は \fBIP_PKTINFO\fP メッセージを通過させるかどうかをソケットに知らせるフラグである。
 270 メッセージ自身は \fBrecvmsg\fP(2)  または \fBsendmsg\fP(2)  を用いたパケットの制御メッセージとしてのみ送受信できる。
 271 .IP
 272 .in +4n
 273 .nf
 274 struct in_pktinfo {
 275     unsigned int   ipi_ifindex;  /* Interface index */
 276     struct in_addr ipi_spec_dst; /* Local address */
 277     struct in_addr ipi_addr;     /* Header Destination
 278                                     address */
 279 };
 280 .fi
 281 .in
 282 .IP
 283 .\" FIXME elaborate on that.
 284 .\" This field is grossly misnamed
 285 \fIipi_ifindex\fP はパケットが受信されたインターフェースの、他と重ならないインデックスである。 \fIipi_spec_dst\fP
 286 はパケットのローカルアドレスである。 \fIipi_addr\fP はパケットヘッダにある宛先アドレスである。 \fBIP_PKTINFO\fP が
 287 \fBsendmsg\fP(2)  に渡されて、かつ \fIipi_spec_dst\fP が 0 以外の場合、 \fIipi_spec_dst\fP
 288 はルーティングテーブルを検索する際にローカルな送信元アドレスとして使用され、 IP source route オプションを設定するのにも使用される。
 289 \fIipi_ifindex\fP が 0 以外の場合、このインデックスによって指定されるインターフェースの プライマリローカルアドレスで
 290 \fIipi_spec_dst\fP を上書きし、ルーティングテーブルを検索する。
 291 .TP
 292 \fBIP_RECVERR\fP (Linux 2.2 以降)
 293 .\" Precisely: 2.1.15
 294 .\" or SOL_IP on Linux
 295 エラーメッセージの受け渡しに、信頼性の高い拡張された方法を有効にする。 データグラムソケットに対して有効になっていると、
 296 発生したエラーは全てソケットごとのエラーキューに保存される。 ユーザーはソケット操作からエラーを受け取ったとき、 \fBrecvmsg\fP(2)  を
 297 \fBMSG_ERRQUEUE\fP フラグとともに呼べばそのエラーを取得できる。 そのエラーを記述する \fIsock_extended_err\fP
 298 構造体が、タイプ \fBIP_RECVERR\fP・ レベル \fBIPPROTO_IP\fP の補助メッセージとして渡される。
 299 これは接続志向でないソケットで信頼性の高いエラー処理を行いたい場合に 有用である。エラーキューの受信データフラグメントには エラーパケットが含まれる。
 300 .IP
 301 \fBIP_RECVERR\fP 制御メッセージには \fIsock_extended_err\fP 構造体が含まれる:
 302 .IP
 303 .in +4n
 304 .ne 18
 305 .nf
 306 #define SO_EE_ORIGIN_NONE    0
 307 #define SO_EE_ORIGIN_LOCAL   1
 308 #define SO_EE_ORIGIN_ICMP    2
 309 #define SO_EE_ORIGIN_ICMP6   3
 310
 311 struct sock_extended_err {
 312     uint32_t ee_errno;   /* error number */
 313     uint8_t  ee_origin;  /* where the error originated */
 314     uint8_t  ee_type;    /* type */
 315     uint8_t  ee_code;    /* code */
 316     uint8_t  ee_pad;
 317     uint32_t ee_info;    /* additional information */
 318     uint32_t ee_data;    /* other data */
 319     /* More data may follow */
 320 };
 321
 322 struct sockaddr *SO_EE_OFFENDER(struct sock_extended_err *);
 323 .fi
 324 .in
 325 .IP
 326 \fIee_errno\fP にはキューに入っているエラーの \fIerrno\fP 番号が入る。 \fIee_origin\fP
 327 にはエラーが発生した場所を示すコードが入る。 その他のフィールドはプロトコル依存である。 \fBSO_EE_OFFENDER\fP
 328 マクロは与えられた補助メッセージへのポインタから エラーの発生したネットワークオブジェクトのアドレスへのポインタを返す。 アドレスが不明な場合、
 329 \fIsockaddr\fP 構造体の \fIsa_family\fP フィールドは \fBAF_UNSPEC\fP となり、その他のフィールド値は不定である。
 330 .IP
 331 .\" FIXME . Is it a good idea to document that? It is a dubious feature.
 332 .\" On
 333 .\" .B SOCK_STREAM
 334 .\" sockets,
 335 .\" .B IP_RECVERR
 336 .\" has slightly different semantics. Instead of
 337 .\" saving the errors for the next timeout, it passes all incoming
 338 .\" errors immediately to the user.
 339 .\" This might be useful for very short-lived TCP connections which
 340 .\" need fast error handling. Use this option with care:
 341 .\" it makes TCP unreliable
 342 .\" by not allowing it to recover properly from routing
 343 .\" shifts and other normal
 344 .\" conditions and breaks the protocol specification.
 345 IP は以下のような \fIsock_extended_err\fP 構造体を用いる: \fIee_origin\fP は、エラー
 346 が ICMP パケットとして受信された場合には \fBSO_EE_ORIGIN_ICMP\fP にセットされ、
 347 ローカルで起こった場合には \fBSO_EE_ORIGIN_LOCAL\fP にセットされる。 不明な値は
 348 無視される。 \fIee_type\fP と \fIee_code\fP は ICMP ヘッダの type フィールドと
 349 code フィールドの値にセットされる。 \fIee_info\fP には \fBEMSGSIZE\fP エラーに対す
 350 る discover された MTU が入る。 メッセージにはエラーを引き起こしたノードの
 351 \fIsockaddr_in\fP 構造体も含まれる。 これには \fBSO_EE_OFFENDER\fP マクロを使ってア
 352 クセスできる。 ソースが不明の場合、 \fBSO_EE_OFFENDER\fP アドレスの
 353 \fIsin_family\fP フィールドは \fBAF_UNSPEC\fP となる。 エラーがネットワークで起きた
 354 場合には、 ソケットで有効になっていたすべての IP オプション (\fBIP_OPTIONS\fP,
 355 \fBIP_TTL\fP など) とエラーパケットに含まれていたすべての IP オプションとが、 制
 356 御メッセージとして渡される。 エラーを起こしたパケットのペイロード (payload)
 357 は 普通のペイロードとして返される。 TCP にはエラーキューがないことに注意して
 358 ほしい。 \fBMSG_ERRQUEUE\fP は \fBSOCK_STREAM\fP ソケットに対しては使えない。 TCP
 359 では \fBIP_RECVERR\fP だけが有効だが、ソケット関数から返されるエラーは
 360 \fBSO_ERROR\fP だけになる。
 361 .IP
 362 raw ソケットに対して \fBIP_RECVERR\fP を指定すると、受信したすべての ICMP エラーをアプリケーションに
 363 渡すようになる。指定しないと、 接続済みのソケットに対するエラーだけを報告する。
 364 .IP
 365 このオプションはブール値のフラグを設定・取得する。 \fBIP_RECVERR\fP はデフォルトではオフになっている。
 366 .TP
 367 \fBIP_RECVOPTS\fP (Linux 2.2 以降)
 368 .\" Precisely: 2.1.15
 369 到着した全ての IP オプションを \fBIP_OPTION\fP コントロールメッセージに入れてユーザーに渡す。
 370 ルーティングヘッダとその他のオプションとは、 ローカルホストに対してはあらかじめ記入されている。 \fBSOCK_STREAM\fP
 371 ソケットではサポートされていない。
 372 .TP
 373 \fBIP_RECVORIGDSTADDR\fP (Linux 2.6.29 以降)
 374 .\" commit e8b2dfe9b4501ed0047459b2756ba26e5a940a69
 375 このブール値のオプションがセットされると、
 376 \fBrecvmsg\fP(2) で \fBIP_ORIGDSTADDR\fP 補助メッセージが有効になる。
 377 カーネルはデータグラムを受信した元の宛先アドレスをこの補助メッセージで返す。
 378 この補助メッセージには \fIstruct sockaddr_in\fP が格納される。
 379 .TP
 380 \fBIP_RECVTOS\fP (Linux 2.2 以降)
 381 .\" Precisely: 2.1.68
 382 有効になっていると、 \fBIP_TOS\fP 補助メッセージが到着パケットとともに渡される。 これにはパケットヘッダの Service/Precedence
 383 フィールドのタイプを指定するバイトデータが含まれている。 ブール整数値のフラグをとる。
 384 .TP
 385 \fBIP_RECVTTL\fP (Linux 2.2 以降)
 386 .\" Precisely: 2.1.68
 387 このフラグがセットされていると、 \fBIP_TTL\fP コントロールメッセージが受信パケットの time\-to\-live
 388 フィールドのバイトデータとともに渡される。 \fBSOCK_STREAM\fP ソケットではサポートされていない。
 389 .TP
 390 \fBIP_RETOPTS\fP
 391 .\" Precisely: 2.1.15
 392 \fBIP_RETOPTS\fP (Linux 2.2 以降)  \fBIP_RECVOPTS\fP と等価だが、未処理の生のオプションを、 この hop
 393 では記入されない timestamp レコードと route レコードとともに返す。
 394 .TP
 395 \fBIP_ROUTER_ALERT\fP (Linux 2.2 以降)
 396 .\" Precisely: 2.1.68
 397 フォワードすべきパケットを IP Router Alert オプションをつけて このソケットに渡す。 raw
 398 ソケットに対してのみ有効である。これはたとえばユーザー空間の RSVP デーモンに対して便利である。タップされたパケットは
 399 カーネルによってはフォワードされないので、これらを再送するのは ユーザーの責任となる。ソケットのバインドは無視され、
 400 このようなパケットはプロトコルによってのみフィルタリングされる。 整数値のフラグを取る。
 401 .TP
 402 \fBIP_TOS\fP (Linux 1.0 以降)
 403 .\" FIXME elaborate on this
 404 .\" Needs CAP_NET_ADMIN
 405 .\" Boolean
 406 .\" Since Linux 2.6.27
 407 .\" Author: KOVACS Krisztian <hidden@sch.bme.hu>
 408 .\" http://lwn.net/Articles/252545/
 409 このソケットから送信されるすべての IP パケットに適用される Type\-Of\-Service (TOS) フィールドを設定・取得する。
 410 これはネットワーク上でのパケットの優先度を決めるために用いられる。 TOS はバイトデータである。標準の TOS フラグがいくつか定義されている。
 411 \fBIPTOS_LOWDELAY\fP はインタラクティブなトラフィックの遅延を最小にする。 \fBIPTOS_THROUGHPUT\fP
 412 はスループットを最大にする。 \fBIPTOS_RELIABILITY\fP は信頼性を最高にする。 \fBIPTOS_MINCOST\fP
 413 は転送速度が遅くてもかまわないとき、「データを詰め込む」のに用いられる。 これらのうち、 1 つまでだけを設定できる。
 414 他のビットは無効で、クリアされる。 Linux はデフォルトでは \fBIPTOS_LOWDELAY\fP データグラムを最初に送信する。
 415 しかし、正確な振る舞いはキュー処理の設定に依存する。 高い優先度にするにはスーパーユーザー権限 (\fBCAP_NET_ADMIN\fP ケーパビリティ)
 416 が必要となるかもしれない。 優先度は (\fBSOL_SOCKET\fP, \fBSO_PRIORITY\fP)  ソケットオプションを用いれば、
 417 プロトコルに依存しない形でも設定できる (\fBsocket\fP(7)  を見よ)。
 418 .TP
 419 \fBIP_TRANSPARENT\fP (Linux 2.6.24 以降)
 420 .\" commit f5715aea4564f233767ea1d944b2637a5fd7cd2e
 421 .\"     This patch introduces the IP_TRANSPARENT socket option: enabling that
 422 .\"     will make the IPv4 routing omit the non-local source address check on
 423 .\"     output. Setting IP_TRANSPARENT requires NET_ADMIN capability.
 424 .\" http://lwn.net/Articles/252545/
 425 このブール値のオプションを有効にすると、
 426 このソケットで透過プロキシ (transparent proxy) ができるようになる。
 427 このソケットオプションを使うと、呼び出したアプリケーションは、
 428 ローカルではない IP アドレスをバインドして、ローカルの端点として自分以外の
 429 アドレス (foreign address) を持つクライアントやサーバの両方として
 430 動作できるようになる。
 431 \fB注意\fP: この機能が動作するためには、自分以外のアドレス宛のパケットが
 432 透過プロキシが動作するマシン (TProxy box) 経由で転送されるように、
 433 ルーティングが設定される必要がある。
 434 このソケットオプションを有効にするには、スーパーユーザ特権
 435 (\fBCAP_NET_ADMIN\fP ケーパビリティ) が必要である。
 436 .IP
 437 iptables の TPROXY ターゲットで透過プロキシリダイレクション
 438 (TProxy redirection) を行うには、リダイレクトされるソケットに対して
 439 このオプションを設定する必要がある。
 440 .TP
 441 \fBIP_TTL\fP (Linux 1.0 以降)
 442 .\" FIXME Document IP_XFRM_POLICY
 443 .\" Since Linux 2.5.48
 444 .\" Needs CAP_NET_ADMIN
 445 time\-to\-live フィールドの値を設定または取得する。 この値はこのソケットから送信されるすべてのパケットに用いられる。
 446 .SS "/proc インタフェース"
 447 .\" FIXME As at 2.6.12, 14 Jun 2005, the following are undocumented:
 448 .\"     ip_queue_maxlen
 449 .\"     ip_conntrack_max
 450 .\"
 451 IP プロトコルでは、いくつかのグローバルパラメータを設定するための \fI/proc\fP ファイル群が用意されている。 これらのパラメータには、
 452 \fI/proc/sys/net/ipv4/\fP ディレクトリ内のファイルの読み書きでアクセスできる。 \fIBoolean\fP
 453 と書かれたインタフェースは整数値をとり、 0 以外の値 ("true") は対応するオプションが有効、 0 値 ("false")
 454 は無効、であることを意味する。
 455 .TP
 456 \fIip_always_defrag\fP (Boolean; Linux 2.2.13 以降)
 457 [2.2.13 で新規登場。以前のバージョンのカーネルでは、この機能は コンパイル時に \fBCONFIG_IP_ALWAYS_DEFRAG\fP
 458 オプションによって制御されていた; このファイルは 2.4.x 以降では存在しない]
 459
 460 このブール値のフラグが有効になっている (0 以外になっている) と、 到着したフラグメント (IP パケットの一部で、
 461 発信元と発信先の間のどこかのホストで、そのパケットが 大きすぎると判断され、分割された場合に生じる)  は、たとえフォワードされる場合であっても
 462 処理前に再構築 (デフラグメント) される。
 463
 464 ファイアウォールがローカル側のネットワークに唯一のリンクを持っている 場合や、透過プロクシの場合に限って有効にすべきである。
 465 通常のルーターやホストでは決して使用することのないように。 さもないとフラグメントが別のリンクを経由して伝わる場合に、
 466 通信のフラグメント化ができなくなってしまう。 またフラグメント再構築処理はメモリと CPU 時間のコストが非常に大きい。
 467
 468 .\"
 469 これはマスカレードや透過プロクシが設定されると、 不思議な仕組みによって自動的に有効になる。
 470 .TP
 471 \fIip_autoconfig\fP (Linux 2.2 以降 2.6.17 まで)
 472 .\" Precisely: since 2.1.68
 473 .\" FIXME document ip_autoconfig
 474 .\"
 475 まだ記述していない。
 476 .TP
 477 \fIip_default_ttl\fP (integer; default: 64; Linux 2.2 以降)
 478 .\" Precisely: 2.1.15
 479 .\"
 480 送出されるパケットの time\-to\-live 値のデフォルトをセットする。 これは \fBIP_TTL\fP
 481 オプションを用いれば、パケットごとに変えることもできる。
 482 .TP
 483 \fIip_dynaddr\fP (Boolean; default: disabled; Linux 2.0.31 以降)
 484 .\"
 485 動的ソケットアドレスと、インターフェースアドレスが変更された際の マスカレードエントリの再書き込みを有効にする。 ダイアルアップインターフェースで、
 486 IP アドレスが変更される場合に便利である。
 487 .TP
 488 \fIip_forward\fP (Boolean; default: disabled; Linux 1.2 以降)
 489 .\"
 490 IP forwarding を有効にするかどうかのブール値フラグ。 IP forwarding するかどうかはインターフェースごとにも設定できる。
 491 .TP
 492 \fIip_local_port_range\fP (Linux 2.2 以降)
 493 .\" Precisely: since 2.1.68
 494 .\"
 495 ソケットに割り当てられているデフォルトのローカルポートの範囲を定める 二つの整数を与える。割り当ては 1 番目の番号から始まり、 2
 496 番目の番号で終わる。 これらはマスカレードで用いられているポートと重なってはならない (その場合も取り扱われるが)。
 497 ファイアウォールのパケットフィルターが「利用中のローカルポート」 について何らかの仮定をしている場合には、
 498 番号を勝手に決めてしまうと問題が起きるかもしれない。 1 番目の番号は少なくとも 1024 より大きくすべきである。
 499 良く使われるポートとの衝突を避けたり、ファイアウォールの問題を 回避したければ、 4096 よりも大きくするほうが良いだろう。
 500 .TP
 501 \fIip_no_pmtu_disc\fP (Boolean; default: disabled; Linux 2.2 以降)
 502 .\" Precisely: 2.1.15
 503 .\"
 504 .\" The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
 505 有効になっていると、デフォルトで TCP ソケットに対する Path MTU Discoverty を行わない。 Path MTU Discovery
 506 は、 正しく設定されていない (ICMP パケットを全てドロップする) ファイアウォールや、 (point\-to\-point リンクで双方の MTU
 507 が一致していない場合など)  正しく設定されていないインターフェースが経路上に存在すると失敗してしまう。 Path MTU Discovery
 508 をグローバルに無効にするよりは、 壊れているルータを直すほうが良い。 Path MTU Discovery を無効にするとネットワークのコストが
 509 大きくなってしまうからである。
 510 .TP
 511 \fIip_nonlocal_bind\fP (Boolean; default: disabled; Linux 2.4 以降)
 512 .\" Precisely: patch-2.4.0-test10
 513 .\"
 514 .\" The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
 515 セットされていれば、プロセスが自分以外の IP アドレスを \fBbind\fP(2)
 516 できるようになる。これはかなり便利だが、うまく動かないアプリケーションもある。
 517 .TP
 518 \fIip6frag_time\fP (integer; default: 30)
 519 .\"
 520 .\" The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
 521 IPv6 フラグメントをメモリに保持しておく時間 (秒単位)。
 522 .TP
 523 \fIip6frag_secret_interval\fP (integer; default: 600)
 524 IPv6 フラグメントの hash secret の生成間隔 (hash secret の寿命)  (秒単位)。
 525 .TP
 526 \fIipfrag_high_thresh\fP (integer), \fIipfrag_low_thresh\fP (integer)
 527 キューイングされている IP フラグメントの量が \fIipfrag_high_thresh\fP に達すると、キューの内容は
 528 \fIipfrag_low_thresh\fP にまで切り捨てられる。それぞれの大きさを バイト単位で表す整数値が入っている。
 529 .TP
 530 \fIneigh/*\fP
 531 .\" FIXME Document the conf/*/* interfaces
 532 .\" FIXME Document the route/* interfaces
 533 .\" FIXME document them all
 534 \fBarp\fP(7)  を見よ。
 535 .SS ioctl
 536 .\" 2006-04-02, mtk
 537 .\" commented out the following because ipchains is obsolete
 538 .\" .PP
 539 .\" The ioctls to configure firewalling are documented in
 540 .\" .BR ipfw (4)
 541 .\" from the
 542 .\" .B ipchains
 543 .\" package.
 544 \fBsocket\fP(7)  に記述されている ioctl は、すべて \fBip\fP にも適用される。
 545 .PP
 546 .\" FIXME Add a discussion of multicasting
 547 ジェネリックデバイスのパラメータを設定する ioctl については \fBnetdevice\fP(7)  に記述されている。
 548 .SH エラー
 549 .\" FIXME document all errors.
 550 .\"     We should really fix the kernels to give more uniform
 551 .\"     error returns (ENOMEM vs ENOBUFS, EPERM vs EACCES etc.)
 552 .TP
 553 \fBEACCES\fP
 554 必要な権限のないユーザーが操作を実行しようとした。 以下のような場合が考えられる: \fBSO_BROADCAST\fP
 555 フラグを設定していない状態でブロードキャストアドレスに パケットを送ろうとした。 \fIprohibit\fP なルートを通してパケットを送ろうとした。
 556 スーパーユーザー権限 (\fBCAP_NET_ADMIN\fP ケーパビリティ) なしでファイアウォールの設定を変更しようとした。 スーパーユーザー権限
 557 (\fBCAP_NET_BIND_SERVICE\fP ケーパビリティ) なしで特権ポートにバインドしようとした。
 558 .TP
 559 \fBEADDRINUSE\fP
 560 既に使用されているアドレスにバインドしようとした。
 561 .TP
 562 \fBEADDRNOTAVAIL\fP
 563 存在しないインターフェースが要求された。または 要求されたソースアドレスがローカルでない。
 564 .TP
 565 \fBEAGAIN\fP
 566 非ブロッキングソケットに対してブロックする操作を行った。
 567 .TP
 568 \fBEALREADY\fP
 569 非ブロッキングソケットに対する接続操作が既に実行中である。
 570 .TP
 571 \fBECONNABORTED\fP
 572 \fBaccept\fP(2)  の途中で接続がクローズされた。
 573 .TP
 574 \fBEHOSTUNREACH\fP
 575 宛先アドレスにマッチする有効なエントリがルーティングテーブルに 存在しない。このエラーはリモートルータからの、 あるいはローカルルーティングテーブルへの
 576 ICMP メッセージによって引き起こされることがある。
 577 .TP
 578 \fBEINVAL\fP
 579 不正な引き数が渡された。送信操作において、 \fIblackhole\fP ルートに送信しようとするとこのエラーが起こることがある。
 580 .TP
 581 \fBEISCONN\fP
 582 接続済みのソケットに対して \fBconnect\fP(2)  が呼ばれた。
 583 .TP
 584 \fBEMSGSIZE\fP
 585 データグラムが path MTU よりも大きく、フラグメント化もできない。
 586 .TP
 587 \fBENOBUFS\fP, \fBENOMEM\fP
 588 空きメモリが足りない。 このエラーは、メモリアロケーションがソケットバッファの 大きさによって制限されていることを意味しているのが通常であるが、
 589 100% そうだというわけではない。
 590 .TP
 591 \fBENOENT\fP
 592 パケットが到着していないソケットに対して \fBSIOCGSTAMP\fP が呼ばれた。
 593 .TP
 594 \fBENOPKG\fP
 595 カーネルサブシステムが設定されていない。
 596 .TP
 597 \fBENOPROTOOPT\fP と \fBEOPNOTSUPP\fP
 598 無効なソケットオプションが渡された。
 599 .TP
 600 \fBENOTCONN\fP
 601 接続されていないソケットに対して、 接続状態でしか定義されていない操作を行おうとした。
 602 .TP
 603 \fBEPERM\fP
 604 高い優先度を設定したり、設定を変更したり、要求されたプロセスや プロセスグループにシグナルを送ったりするのに必要な権限を、 ユーザーが持っていない。
 605 .TP
 606 \fBEPIPE\fP
 607 接続が接続相手によって、予期しないやり方でクローズまたはシャットダウンされた。
 608 .TP
 609 \fBESOCKTNOSUPPORT\fP
 610 ソケットが未設定であるか、知らないソケットタイプが要求された。
 611 .PP
 612 他のエラーが上層のプロトコルによって生じるかもしれない。 \fBtcp\fP(7), \fBraw\fP(7), \fBudp\fP(7), \fBsocket\fP(7)
 613 などを参照のこと。
 614 .SH 注意
 615 .\" IP_PASSSEC is Linux-specific
 616 .\" IP_XFRM_POLICY is Linux-specific
 617 .\" IP_IPSEC_POLICY is a nonstandard extension, also present on some BSDs
 618 \fBIP_FREEBIND\fP, \fBIP_MTU\fP, \fBIP_MTU_DISCOVER\fP, \fBIP_RECVORIGDSTADDR\fP,
 619 \fBIP_PKTINFO\fP, \fBIP_RECVERR\fP, \fBIP_ROUTER_ALERT\fP, and \fBIP_TRANSPARENT\fP
 620 は Linux 固有である。
 621
 622 \fBSO_BROADCAST\fP オプションの利用には、くれぐれも注意すること。
 623 これは Linux では特権操作ではない。
 624 不注意なブロードキャストを行うと、ネットワークは簡単に過負荷状態になる。
 625 新しいアプリケーションプロトコルには、ブロードキャストではなく
 626 マルチキャストグループを用いるほうがよい。 ブロードキャストは推奨されない。
 627 .PP
 628 他の BSD のソケット実装では、 \fBIP_RCVDSTADDR\fP と \fBIP_RECVIF\fP といったソケットオプションがサポートされており、
 629 宛先アドレスや受信データグラムのインターフェースが取得できるように なっていることもある。 Linux で同じことをやらせるには、より一般的な
 630 \fBIP_PKTINFO\fP が使える。
 631 .PP
 632 いくつかの BSD のソケット実装では \fBIP_RECVTTL\fP オプションも提供されているが、タイプ \fBIP_RECVTTL\fP
 633 の補助メッセージは受信パケットとともに渡される。 これは Linux で使われている \fBIP_TTL\fP オプションとは異なる動作である。
 634 .PP
 635 \fBSOL_IP\fP ソケットオプションレベルは移植性がない。 BSD ベースのプロトコルスタックでは \fBIPPROTO_IP\fP
 636 レベルが使用されている。
 637 .SS 移植性
 638 Linux 2.0 との互換性のために、 obsolete な \fBsocket(AF_INET, SOCK_PACKET,
 639 \fP\fIprotocol\fP\fB)\fP という書式でも \fBpacket\fP(7)  をオープンできるようになっているが、これはお勧めできない。今後は
 640 \fBsocket(AF_PACKET, SOCK_RAW, \fP\fIprotocol\fP\fB)\fP
 641 を代わりに用いるべきである。主な違いは、ジェネリックなリンク層用の \fIsockaddr_ll\fP アドレス構造体が、古い \fBsockaddr_pkt\fP
 642 に変わって用いられるようになったことである。
 643 .SH バグ
 644 エラーの値がまったく首尾一貫していない。
 645 .PP
 646 IP 固有のインターフェースオプションを指定するための ioctl と ARP テーブルのことが記述されていない。
 647 .PP
 648 glibc のバージョンによっては \fIin_pktinfo\fP の定義を忘れているものがある。 現時点でのとりあえずの対策としては、この man
 649 ページにある定義をプログラム中に コピーすることである。
 650 .PP
 651 .\" .SH AUTHORS
 652 .\" This man page was written by Andi Kleen.
 653 \fBrecvmsg\fP(2)  で \fImsg_name\fP に \fBMSG_ERRQUEUE\fP
 654 を指定して、受信パケットに入っていた宛先アドレスを取得する方法は 2.2 カーネルの一部でうまく動かない。
 655 .SH 関連項目
 656 \fBrecvmsg\fP(2), \fBsendmsg\fP(2), \fBbyteorder\fP(3), \fBipfw\fP(4),
 657 \fBcapabilities\fP(7), \fBnetlink\fP(7), \fBraw\fP(7), \fBsocket\fP(7), \fBtcp\fP(7),
 658 \fBudp\fP(7)
 659 .PP
 660 \fBRFC\ 791\fP: オリジナルの IP の仕様
 661 .br
 662 \fBRFC\ 1122\fP: IPv4 ホストの必要条件
 663 .br
 664 .\" FIXME autobind INADDR REUSEADDR
 665 \fBRFC\ 1812\fP: IPv4 ルータの必要条件
 666 .SH この文書について
 667 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.41 の一部
 668 である。プロジェクトの説明とバグ報告に関する情報は
 669 http://www.kernel.org/doc/man\-pages/ に書かれている。