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 にセットすべきである。
90 IFLA_UNSPEC:\-:指定されていない。
91 IFLA_ADDRESS:hardware address:インターフェース L2 アドレス
92 IFLA_BROADCAST:hardware address:L2 ブロードキャストアドレス
93 IFLA_IFNAME:asciiz string:デバイス名
94 IFLA_MTU:unsigned int:デバイスの MTU
96 IFLA_QDISC:asciiz string:キューイングのルール
102 \fBIFLA_STATS\fP の値の型は \fIstruct rtnl_link_stats\fP (Linux 2.4 以前では \fIstruct
103 net_device_stats\fP) である。
105 \fBRTM_NEWADDR\fP, \fBRTM_DELADDR\fP, \fBRTM_GETADDR\fP
106 インターフェースの IP アドレスの情報を追加・削除・取得する。 Linux 2.2 では、一つのインターフェースに複数の IP アドレスを
107 保持させることができ、これは 2.0 の別名デバイスの概念を置き換える。 Linux 2.2 では、これらのメッセージは IPv4 と IPv6
108 の両方のアドレスをサポートしている。 これらは \fIifaddrmsg\fP 構造体を伴う。そのあとに \fIrtattr\fP
113 unsigned char ifa_family; /* Address type */
114 unsigned char ifa_prefixlen; /* Prefixlength of address */
115 unsigned char ifa_flags; /* Address flags */
116 unsigned char ifa_scope; /* Address scope */
117 int ifa_index; /* Interface index */
121 \fIifa_family\fP はアドレスファミリーのタイプである (現在は \fBAF_INET\fP または \fBAF_INET6\fP)。
122 \fIifa_prefixlen\fP はアドレスのアドレスマスクの長さである (IPv4 のように、 そのファミリーで定義されている場合)。
123 \fIifa_scope\fP はアドレスのスコープである。 \fIifa_index\fP はアドレスが関連づけられているインターフェースの index である。
124 \fIifa_flags\fP はフラグワードで、 二つめのアドレス (古い別名インターフェース) の場合は \fBIFA_F_SECONDARY\fP
125 に、永続的なアドレスの場合は \fBIFA_F_PERMANENT\fP に適用される。ユーザーによってセットされるフラグと、 undocumented
134 IFA_UNSPEC:\-:指定されていない
135 IFA_ADDRESS:raw protocol address:インターフェースアドレス
136 IFA_LOCAL:raw protocol address:ローカルアドレス
137 IFA_LABEL:asciiz string:インターフェースの名前
138 IFA_BROADCAST:raw protocol address:ブロードキャストアドレス
139 IFA_ANYCAST:raw protocol address:anycast アドレス
140 IFA_CACHEINFO:struct ifa_cacheinfo:アドレス情報
142 .\" FIXME struct ifa_cacheinfo
144 \fBRTM_NEWROUTE\fP, \fBRTM_DELROUTE\fP, \fBRTM_GETROUTE\fP
145 ネットワーク経路の情報を生成・削除・取得する。 これらのメッセージは \fIrtmsg\fP 構造体を伴う。そのあとにいくつかの \fIrtattr\fP
146 構造体を続けることもできる。 \fBRTM_GETROUTE\fP で \fIrtm_dst_len\fP と \fIrtm_src_len\fP に 0
147 をセットすると、 指定されたルーティングテーブルの全てのエントリを所得する。 \fIrtm_table\fP と \fIrtm_protocol\fP
148 以外の他のフィールドに 0 を入れると、ワイルドカードを意味する。
152 unsigned char rtm_family; /* Address family of route */
153 unsigned char rtm_dst_len; /* Length of destination */
154 unsigned char rtm_src_len; /* Length of source */
155 unsigned char rtm_tos; /* TOS filter */
157 unsigned char rtm_table; /* Routing table ID */
158 unsigned char rtm_protocol; /* Routing protocol; see below */
159 unsigned char rtm_scope; /* See below */
160 unsigned char rtm_type; /* See below */
162 unsigned int rtm_flags;
171 RTN_UNICAST:ゲートウェイまたはダイレクトな経路
172 RTN_LOCAL:ローカルインターフェースの経路
174 ローカルなブロードキャスト経路 (ブロードキャストとして送信される)
177 ローカルなブロードキャスト経路 (ユニキャストとして送信される)
179 RTN_MULTICAST:マルチキャスト経路
180 RTN_BLACKHOLE:パケットを捨てる経路
181 RTN_UNREACHABLE:到達できない行き先
182 RTN_PROHIBIT:パケットを拒否する経路
183 RTN_THROW:経路探索を別のテーブルで継続
184 RTN_NAT:ネットワークアドレスの変換ルール
196 ICMP リダイレクトによる (現在は用いられない)
198 RTPROT_KERNEL:カーネルによる
203 \fBRTPROT_STATIC\fP よりも大きな値はカーネルによって解釈されない。これは 単なるユーザーへの情報である。これらは経路情報の情報源を
204 タグ付けしたり、複数のルーティングデーモンからの情報を 区別するために用いることができる。 既に割り当てられているルーティングデーモンの識別子については
205 \fI<linux/rtnetlink.h>\fP を見よ。
207 \fIrtm_scope\fP は行き先への距離である。
211 RT_SCOPE_UNIVERSE:グローバルな経路
215 RT_SCOPE_LINK:このリンク上の経路
216 RT_SCOPE_HOST:ローカルホスト上の経路
217 RT_SCOPE_NOWHERE:行き先が存在しない
220 ユーザーは \fBRT_SCOPE_UNIVERSE\fP と \fBRT_SCOPE_SITE\fP の間の値を用いることができる。
222 \fIrtm_flags\fP は以下の意味を持つ:
227 経路が変更されると、 rtnetlink を通してユーザーに通知が行く。
229 RTM_F_CLONED:経路は他の経路によって複製された。
230 RTM_F_EQUALIZE:マルチパスイコライザ (まだ実装されていない)
233 \fIrtm_table\fP ではルーティングテーブルを指定する。
237 RT_TABLE_UNSPEC:指定されていないルーティングテーブル
238 RT_TABLE_DEFAULT:デフォルトのテーブル
239 RT_TABLE_MAIN:メインのテーブル
240 RT_TABLE_LOCAL:ローカルテーブル
243 .\" Keep table on same page
244 ユーザーは \fBRT_TABLE_UNSPEC\fP と \fBRT_TABLE_DEFAULT\fP. の間の任意の値を用いることができる。
254 RTA_DST:protocol address:経路の行き先アドレス
255 RTA_SRC:protocol address:経路の発信元アドレス
256 RTA_IIF:int:入力インターフェースの index
257 RTA_OIF:int:出力インターフェースの index
258 RTA_GATEWAY:protocol address:経路のゲートウェイ
259 RTA_PRIORITY:int:経路の優先度
261 RTA_METRICS:int:経路のメトリック
270 \fBRTM_NEWNEIGH\fP, \fBRTM_DELNEIGH\fP, \fBRTM_GETNEIGH\fP
271 近傍テーブル (neighbor table) のエントリ (例えば ARP エントリ) の情報を追加・削除・取得する。 このメッセージは
276 unsigned char ndm_family;
277 int ndm_ifindex; /* Interface index */
278 __u16 ndm_state; /* State */
279 __u8 ndm_flags; /* Flags */
283 struct nda_cacheinfo {
291 \fIndm_state\fP は以下の状態のビットマスクである:
295 NUD_INCOMPLETE:現在レゾルブ中のキャッシュエントリ
296 NUD_REACHABLE:動作確認済みのキャッシュエントリ
297 NUD_STALE:期限切れのキャッシュエントリ
298 NUD_DELAY:タイマ待ちのキャッシュエントリ
299 NUD_PROBE:再確認中のキャッシュエントリ
300 NUD_FAILED:不正なキャッシュエントリ
301 NUD_NOARP:行き先キャッシュのないデバイス
302 NUD_PERMANENT:静的なエントリ
305 有効な \fIndm_flags\fP は以下の通り:
309 NTF_PROXY:プロクシ arp エントリ
314 .\" document the members of the struct better
315 \fIrtattr\fP 構造体は、 \fIrta_type\fP フィールドに応じてそれぞれ以下の意味を持つ:
320 NDA_DST:近傍キャッシュネットワーク層の行き先アドレス
321 NDA_LLADDR:近傍キャッシュリンク層のアドレス
322 NDA_CACHEINFO:キャッシュの統計
325 \fIrta_type\fP フィールドが \fBNDA_CACHEINFO\fP の場合には、 \fIstruct nda_cacheinfo\fP ヘッダが続く。
327 \fBRTM_NEWRULE\fP, \fBRTM_DELRULE\fP, \fBRTM_GETRULE\fP
328 ルーティングルールを追加・削除・取得する。 \fIstruct rtmsg\fP を伴う。
330 \fBRTM_NEWQDISC\fP, \fBRTM_DELQDISC\fP, \fBRTM_GETQDISC\fP
331 キューイングルールを追加・削除・取得する。 このメッセージは \fIstruct tcmsg\fP を伴い、またそのあとに属性がいくつか続くこともある。
335 unsigned char tcm_family;
336 int tcm_ifindex; /* interface index */
337 __u32 tcm_handle; /* Qdisc handle */
338 __u32 tcm_parent; /* Parent qdisc */
349 TCA_UNSPEC:\-:指定されていない
350 TCA_KIND:asciiz string:キューイングルールの名前
351 TCA_OPTIONS:byte sequence:Qdisc 特有のオプションが続く
352 TCA_STATS:struct tc_stats:Qdisc の統計
353 TCA_XSTATS:qdisc\-specific:モジュール特有の統計
354 TCA_RATE:struct tc_estimator:レート制限
357 さらに、 qdisc モジュール特有の様々な属性を指定できる。 詳細な情報は適切なインクルードファイルを見よ。
359 \fBRTM_NEWTCLASS\fP, \fBRTM_DELTCLASS\fP, \fBRTM_GETTCLASS\fP
360 トラフィッククラスを追加・削除・取得する。 これらのメッセージは、上述の \fIstruct tcmsg\fP を伴う。
362 \fBRTM_NEWTFILTER\fP, \fBRTM_DELTFILTER\fP, \fBRTM_GETTFILTER\fP
363 トラフィックフィルターの情報を追加・削除・取得する。 これらのメッセージは、上述の \fIstruct tcmsg\fP を伴う。
365 \fBrtnetlink\fP は Linux 2.2 の新機能である。
369 \fBcmsg\fP(3), \fBrtnetlink\fP(3), \fBip\fP(7), \fBnetlink\fP(7)
371 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.64 の一部
372 である。プロジェクトの説明とバグ報告に関する情報は
373 http://www.kernel.org/doc/man\-pages/ に書かれている。