2 .\" This man page is Copyright (C) 1999 Andi Kleen <ak@muc.de>.
4 .\" %%%LICENSE_START(VERBATIM_ONE_PARA)
5 .\" Permission is granted to distribute possibly modified copies
6 .\" of this page provided the header is included verbatim,
7 .\" and in case of nontrivial modification author and date
8 .\" of the modification is added to the header.
11 .\" Based on the original comments from Alexey Kuznetsov, written with
12 .\" help from Matthew Wilcox.
13 .\" $Id: rtnetlink.7,v 1.8 2000/01/22 01:55:04 freitag Exp $
15 .\"*******************************************************************
17 .\" This file was generated with po4a. Translate the source file.
19 .\"*******************************************************************
21 .\" Japanese Version Copyright (c) 1999 NAKANO Takeo all rights reserved.
22 .\" Translated Mon 6 Dec 1999 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
23 .\" Updated 2013-05-01, Akihiro MOTOKI <amotoki@gmail.com>
24 .\" Updated 2013-05-04, Akihiro MOTOKI <amotoki@gmail.com>
26 .TH RTNETLINK 7 2013\-03\-05 Linux "Linux Programmer's Manual"
28 rtnetlink \- Linux IPv4 ルーティングソケット
30 \fB#include <asm/types.h>\fP
32 \fB#include <linux/netlink.h>\fP
34 \fB#include <linux/rtnetlink.h>\fP
36 \fB#include <sys/socket.h>\fP
38 \fBrtnetlink_socket = socket(AF_NETLINK, int \fP\fIsocket_type\fP\fB,
41 .\" FIXME ? all these macros could be moved to rtnetlink(3)
42 \fBrtnetlink\fP はカーネルのルーティングテーブルを読んだり変更したり するためのものである。これはカーネルが内部のサブシステムと
43 通信するためにも用いられているが、それはここでは記述しない。 この man ページではユーザー空間のプログラムとの通信に関してのみ述べる。
44 ネットワーク経路・IP アドレス・リンクパラメータ・ 近傍設定 (neighbor setup)・キューイングルール (queueing
45 dicipline)・ トラフィッククラス・パケットのクラス分類などが、すべて \fBNETLINK_ROUTE\fP ソケットを通して制御できる。
46 \fBrtnetlink\fP は netlink メッセージをベースにしている。詳細は \fBnetlink\fP(7) を見ること。
48 rtnetlink メッセージには、初期ヘッダの後に付加的な属性を 持つものがある。
53 unsigned short rta_len; /* Length of option */
54 unsigned short rta_type; /* Type of option */
60 これらの属性の操作は、 RTA_* マクロか libnetlink のみを使って行うべきである。 \fBrtnetlink\fP(3) を見よ。
62 rtnetlink は (標準的な netlink メッセージに加えて) 以下のメッセージタイプから構成される。
64 \fBRTM_NEWLINK\fP, \fBRTM_DELLINK\fP, \fBRTM_GETLINK\fP
65 指定したネットワークインターフェースの情報を、生成・削除・取得する。 これらのメッセージは \fIifinfomsg\fP 構造体と、それに続いていくつかの
70 unsigned char ifi_family; /* AF_UNSPEC */
71 unsigned short ifi_type; /* Device type */
72 int ifi_index; /* Interface index */
73 unsigned int ifi_flags; /* Device flags */
74 unsigned int ifi_change; /* change mask */
79 \fIifi_flags\fP はデバイスのフラグである。 \fBnetdevice\fP(7) を参照。 \fIifi_index\fP
80 は他と重ならないインターフェースの index である (Linux 3.7 以降では、 \fBRTMGRP_LINK\fP メッセージで 0
81 以外の値を指定することができ、そのため指定した \fIifindex\fP でリンクを作成できる)。 \fIifi_change\fP
82 は将来の利用のために予約されており、常に 0xFFFFFFFF にセットすべきである。
91 IFLA_UNSPEC:\-:指定されていない。
92 IFLA_ADDRESS:hardware address:インターフェース L2 アドレス
93 IFLA_BROADCAST:hardware address:L2 ブロードキャストアドレス
94 IFLA_IFNAME:asciiz string:デバイス名
95 IFLA_MTU:unsigned int:デバイスの MTU
97 IFLA_QDISC:asciiz string:キューイングのルール
104 \fBIFLA_STATS\fP の値の型は \fIstruct rtnl_link_stats\fP (Linux 2.4 以前では \fIstruct
105 net_device_stats\fP) である。
107 \fBRTM_NEWADDR\fP, \fBRTM_DELADDR\fP, \fBRTM_GETADDR\fP
108 インターフェースの IP アドレスの情報を追加・削除・取得する。 Linux 2.2 では、一つのインターフェースに複数の IP アドレスを
109 保持させることができ、これは 2.0 の別名デバイスの概念を置き換える。 Linux 2.2 では、これらのメッセージは IPv4 と IPv6
110 の両方のアドレスをサポートしている。 これらは \fIifaddrmsg\fP 構造体を伴う。そのあとに \fIrtattr\fP
115 unsigned char ifa_family; /* Address type */
116 unsigned char ifa_prefixlen; /* Prefixlength of address */
117 unsigned char ifa_flags; /* Address flags */
118 unsigned char ifa_scope; /* Address scope */
119 int ifa_index; /* Interface index */
123 \fIifa_family\fP はアドレスファミリーのタイプである (現在は \fBAF_INET\fP または \fBAF_INET6\fP)。
124 \fIifa_prefixlen\fP はアドレスのアドレスマスクの長さである (IPv4 のように、 そのファミリーで定義されている場合)。
125 \fIifa_scope\fP はアドレスのスコープである。 \fIifa_index\fP はアドレスが関連づけられているインターフェースの index である。
126 \fIifa_flags\fP はフラグワードで、 二つめのアドレス (古い別名インターフェース) の場合は \fBIFA_F_SECONDARY\fP
127 に、永続的なアドレスの場合は \fBIFA_F_PERMANENT\fP に適用される。ユーザーによってセットされるフラグと、 undocumented
136 IFA_UNSPEC:\-:指定されていない
137 IFA_ADDRESS:raw protocol address:インターフェースアドレス
138 IFA_LOCAL:raw protocol address:ローカルアドレス
139 IFA_LABEL:asciiz string:インターフェースの名前
140 IFA_BROADCAST:raw protocol address:ブロードキャストアドレス
141 IFA_ANYCAST:raw protocol address:anycast アドレス
142 IFA_CACHEINFO:struct ifa_cacheinfo:アドレス情報
144 .\" FIXME struct ifa_cacheinfo
146 \fBRTM_NEWROUTE\fP, \fBRTM_DELROUTE\fP, \fBRTM_GETROUTE\fP
147 ネットワーク経路の情報を生成・削除・取得する。 これらのメッセージは \fIrtmsg\fP 構造体を伴う。そのあとにいくつかの \fIrtattr\fP
148 構造体を続けることもできる。 \fBRTM_GETROUTE\fP で \fIrtm_dst_len\fP と \fIrtm_src_len\fP に 0
149 をセットすると、 指定されたルーティングテーブルの全てのエントリを所得する。 \fIrtm_table\fP と \fIrtm_protocol\fP
150 以外の他のフィールドに 0 を入れると、ワイルドカードを意味する。
154 unsigned char rtm_family; /* Address family of route */
155 unsigned char rtm_dst_len; /* Length of destination */
156 unsigned char rtm_src_len; /* Length of source */
157 unsigned char rtm_tos; /* TOS filter */
159 unsigned char rtm_table; /* Routing table ID */
160 unsigned char rtm_protocol; /* Routing protocol; see below */
161 unsigned char rtm_scope; /* See below */
162 unsigned char rtm_type; /* See below */
164 unsigned int rtm_flags;
174 RTN_UNICAST:ゲートウェイまたはダイレクトな経路
175 RTN_LOCAL:ローカルインターフェースの経路
177 ローカルなブロードキャスト経路 (ブロードキャストとして送信される)
180 ローカルなブロードキャスト経路 (ユニキャストとして送信される)
182 RTN_MULTICAST:マルチキャスト経路
183 RTN_BLACKHOLE:パケットを捨てる経路
184 RTN_UNREACHABLE:到達できない行き先
185 RTN_PROHIBIT:パケットを拒否する経路
186 RTN_THROW:経路探索を別のテーブルで継続
187 RTN_NAT:ネットワークアドレスの変換ルール
201 ICMP リダイレクトによる (現在は用いられない)
203 RTPROT_KERNEL:カーネルによる
209 \fBRTPROT_STATIC\fP よりも大きな値はカーネルによって解釈されない。これは 単なるユーザーへの情報である。これらは経路情報の情報源を
210 タグ付けしたり、複数のルーティングデーモンからの情報を 区別するために用いることができる。 既に割り当てられているルーティングデーモンの識別子については
211 \fI<linux/rtnetlink.h>\fP を見よ。
213 \fIrtm_scope\fP は行き先への距離である。
218 RT_SCOPE_UNIVERSE:グローバルな経路
222 RT_SCOPE_LINK:このリンク上の経路
223 RT_SCOPE_HOST:ローカルホスト上の経路
224 RT_SCOPE_NOWHERE:行き先が存在しない
228 ユーザーは \fBRT_SCOPE_UNIVERSE\fP と \fBRT_SCOPE_SITE\fP の間の値を用いることができる。
230 \fIrtm_flags\fP は以下の意味を持つ:
236 経路が変更されると、 rtnetlink を通してユーザーに通知が行く。
238 RTM_F_CLONED:経路は他の経路によって複製された。
239 RTM_F_EQUALIZE:マルチパスイコライザ (まだ実装されていない)
243 \fIrtm_table\fP ではルーティングテーブルを指定する。
247 RT_TABLE_UNSPEC:指定されていないルーティングテーブル
248 RT_TABLE_DEFAULT:デフォルトのテーブル
249 RT_TABLE_MAIN:メインのテーブル
250 RT_TABLE_LOCAL:ローカルテーブル
253 .\" Keep table on same page
254 ユーザーは \fBRT_TABLE_UNSPEC\fP と \fBRT_TABLE_DEFAULT\fP. の間の任意の値を用いることができる。
264 RTA_DST:protocol address:経路の行き先アドレス
265 RTA_SRC:protocol address:経路の発信元アドレス
266 RTA_IIF:int:入力インターフェースの index
267 RTA_OIF:int:出力インターフェースの index
268 RTA_GATEWAY:protocol address:経路のゲートウェイ
269 RTA_PRIORITY:int:経路の優先度
271 RTA_METRICS:int:経路のメトリック
280 \fBRTM_NEWNEIGH\fP, \fBRTM_DELNEIGH\fP, \fBRTM_GETNEIGH\fP
281 近傍テーブル (neighbor table) のエントリ (例えば ARP エントリ) の情報を追加・削除・取得する。 このメッセージは
286 unsigned char ndm_family;
287 int ndm_ifindex; /* Interface index */
288 __u16 ndm_state; /* State */
289 __u8 ndm_flags; /* Flags */
293 struct nda_cacheinfo {
301 \fIndm_state\fP は以下の状態のビットマスクである:
305 NUD_INCOMPLETE:現在レゾルブ中のキャッシュエントリ
306 NUD_REACHABLE:動作確認済みのキャッシュエントリ
307 NUD_STALE:期限切れのキャッシュエントリ
308 NUD_DELAY:タイマ待ちのキャッシュエントリ
309 NUD_PROBE:再確認中のキャッシュエントリ
310 NUD_FAILED:不正なキャッシュエントリ
311 NUD_NOARP:行き先キャッシュのないデバイス
312 NUD_PERMANENT:静的なエントリ
315 有効な \fIndm_flags\fP は以下の通り:
319 NTF_PROXY:プロクシ arp エントリ
324 .\" document the members of the struct better
325 \fIrtattr\fP 構造体は、 \fIrta_type\fP フィールドに応じてそれぞれ以下の意味を持つ:
330 NDA_DST:近傍キャッシュネットワーク層の行き先アドレス
331 NDA_LLADDR:近傍キャッシュリンク層のアドレス
332 NDA_CACHEINFO:キャッシュの統計
335 \fIrta_type\fP フィールドが \fBNDA_CACHEINFO\fP の場合には、 \fIstruct nda_cacheinfo\fP ヘッダが続く。
337 \fBRTM_NEWRULE\fP, \fBRTM_DELRULE\fP, \fBRTM_GETRULE\fP
338 ルーティングルールを追加・削除・取得する。 \fIstruct rtmsg\fP を伴う。
340 \fBRTM_NEWQDISC\fP, \fBRTM_DELQDISC\fP, \fBRTM_GETQDISC\fP
341 キューイングルールを追加・削除・取得する。 このメッセージは \fIstruct tcmsg\fP を伴い、またそのあとに属性がいくつか続くこともある。
345 unsigned char tcm_family;
346 int tcm_ifindex; /* interface index */
347 __u32 tcm_handle; /* Qdisc handle */
348 __u32 tcm_parent; /* Parent qdisc */
359 TCA_UNSPEC:\-:指定されていない
360 TCA_KIND:asciiz string:キューイングルールの名前
361 TCA_OPTIONS:byte sequence:Qdisc 特有のオプションが続く
362 TCA_STATS:struct tc_stats:Qdisc の統計
363 TCA_XSTATS:qdisc specific:モジュール特有の統計
364 TCA_RATE:struct tc_estimator:レート制限
367 さらに、 qdisc モジュール特有の様々な属性を指定できる。 詳細な情報は適切なインクルードファイルを見よ。
369 \fBRTM_NEWTCLASS\fP, \fBRTM_DELTCLASS\fP, \fBRTM_GETTCLASS\fP
370 トラフィッククラスを追加・削除・取得する。 これらのメッセージは、上述の \fIstruct tcmsg\fP を伴う。
372 \fBRTM_NEWTFILTER\fP, \fBRTM_DELTFILTER\fP, \fBRTM_GETTFILTER\fP
373 トラフィックフィルターの情報を追加・削除・取得する。 これらのメッセージは、上述の \fIstruct tcmsg\fP を伴う。
375 \fBrtnetlink\fP は Linux 2.2 の新機能である。
379 \fBcmsg\fP(3), \fBrtnetlink\fP(3), \fBip\fP(7), \fBnetlink\fP(7)
381 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
382 である。プロジェクトの説明とバグ報告に関する情報は
383 http://www.kernel.org/doc/man\-pages/ に書かれている。