release/man7/rtnetlink.7

   1 .\" t
   2 .\" This man page is Copyright (C) 1999 Andi Kleen <ak@muc.de>.
   3 .\"
   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.
   9 .\" %%%LICENSE_END
  10 .\"
  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 $
  14 .\"
  15 .\"*******************************************************************
  16 .\"
  17 .\" This file was generated with po4a. Translate the source file.
  18 .\"
  19 .\"*******************************************************************
  20 .\"
  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>
  25 .\"
  26 .TH RTNETLINK 7 2013\-03\-05 Linux "Linux Programmer's Manual"
  27 .SH 名前
  28 rtnetlink \- Linux IPv4 ルーティングソケット
  29 .SH 書式
  30 \fB#include <asm/types.h>\fP
  31 .br
  32 \fB#include <linux/netlink.h>\fP
  33 .br
  34 \fB#include <linux/rtnetlink.h>\fP
  35 .br
  36 \fB#include <sys/socket.h>\fP
  37 .sp
  38 \fBrtnetlink_socket = socket(AF_NETLINK, int \fP\fIsocket_type\fP\fB,
  39 NETLINK_ROUTE);\fP
  40 .SH 説明
  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)  を見ること。
  47 .SS ルーティング属性
  48 rtnetlink メッセージには、初期ヘッダの後に付加的な属性を 持つものがある。
  49
  50 .in +4n
  51 .nf
  52 struct rtattr {
  53     unsigned short rta_len;    /* Length of option */
  54     unsigned short rta_type;   /* Type of option */
  55     /* Data follows */
  56 };
  57 .fi
  58 .in
  59
  60 これらの属性の操作は、 RTA_* マクロか libnetlink のみを使って行うべきである。 \fBrtnetlink\fP(3)  を見よ。
  61 .SS メッセージ
  62 rtnetlink は (標準的な netlink メッセージに加えて)  以下のメッセージタイプから構成される。
  63 .TP
  64 \fBRTM_NEWLINK\fP, \fBRTM_DELLINK\fP, \fBRTM_GETLINK\fP
  65 指定したネットワークインターフェースの情報を、生成・削除・取得する。 これらのメッセージは \fIifinfomsg\fP 構造体と、それに続いていくつかの
  66 \fIrtattr\fP 構造体を伴う。
  67
  68 .nf
  69 struct ifinfomsg {
  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 */
  75 };
  76 .fi
  77
  78 .\" FIXME ifi_type
  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 にセットすべきである。
  83 .TS
  84 tab(:);
  85 c s s
  86 l l l.
  87 ルーティング属性
  88 rta_type:値の型:説明
  89 _
  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
  95 IFLA_LINK:int:リンクタイプ
  96 IFLA_QDISC:asciiz string:キューイングのルール
  97 IFLA_STATS:T{
  98 下記参照
  99 T}:インターフェースの統計
 100 .TE
 101 .sp
 102 \fBIFLA_STATS\fP の値の型は \fIstruct rtnl_link_stats\fP (Linux 2.4 以前では \fIstruct
 103 net_device_stats\fP) である。
 104 .TP
 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
 109 ルーティング属性が続くこともある。
 110
 111 .nf
 112 struct ifaddrmsg {
 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 */
 118 };
 119 .fi
 120
 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
 126 なフラグがある。
 127 .TS
 128 tab(:);
 129 c s s
 130 l l l.
 131 属性
 132 rta_type:値の型:説明
 133 _
 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:アドレス情報
 141 .TE
 142 .\" FIXME struct ifa_cacheinfo
 143 .TP
 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 を入れると、ワイルドカードを意味する。
 149
 150 .nf
 151 struct rtmsg {
 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 */
 156
 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 */
 161
 162     unsigned int  rtm_flags;
 163 };
 164 .fi
 165 .TS
 166 tab(:);
 167 l l.
 168 rtm_type:経路のタイプ
 169 _
 170 RTN_UNSPEC:未知の経路
 171 RTN_UNICAST:ゲートウェイまたはダイレクトな経路
 172 RTN_LOCAL:ローカルインターフェースの経路
 173 RTN_BROADCAST:T{
 174 ローカルなブロードキャスト経路 (ブロードキャストとして送信される)
 175 T}
 176 RTN_ANYCAST:T{
 177 ローカルなブロードキャスト経路 (ユニキャストとして送信される)
 178 T}
 179 RTN_MULTICAST:マルチキャスト経路
 180 RTN_BLACKHOLE:パケットを捨てる経路
 181 RTN_UNREACHABLE:到達できない行き先
 182 RTN_PROHIBIT:パケットを拒否する経路
 183 RTN_THROW:経路探索を別のテーブルで継続
 184 RTN_NAT:ネットワークアドレスの変換ルール
 185 RTN_XRESOLVE:T{
 186 外部レゾルバを参照 (実装されていない)
 187 T}
 188 .TE
 189 .TS
 190 tab(:);
 191 l l.
 192 rtm_protocol:経路の情報源
 193 _
 194 RTPROT_UNSPEC:不明
 195 RTPROT_REDIRECT:T{
 196 ICMP リダイレクトによる (現在は用いられない)
 197 T}
 198 RTPROT_KERNEL:カーネルによる
 199 RTPROT_BOOT:ブート時
 200 RTPROT_STATIC:管理者による
 201 .TE
 202
 203 \fBRTPROT_STATIC\fP よりも大きな値はカーネルによって解釈されない。これは 単なるユーザーへの情報である。これらは経路情報の情報源を
 204 タグ付けしたり、複数のルーティングデーモンからの情報を 区別するために用いることができる。 既に割り当てられているルーティングデーモンの識別子については
 205 \fI<linux/rtnetlink.h>\fP を見よ。
 206
 207 \fIrtm_scope\fP は行き先への距離である。
 208 .TS
 209 tab(:);
 210 l l.
 211 RT_SCOPE_UNIVERSE:グローバルな経路
 212 RT_SCOPE_SITE:T{
 213 ローカルな自律システムにおける内部経路
 214 T}
 215 RT_SCOPE_LINK:このリンク上の経路
 216 RT_SCOPE_HOST:ローカルホスト上の経路
 217 RT_SCOPE_NOWHERE:行き先が存在しない
 218 .TE
 219
 220 ユーザーは \fBRT_SCOPE_UNIVERSE\fP と \fBRT_SCOPE_SITE\fP の間の値を用いることができる。
 221
 222 \fIrtm_flags\fP は以下の意味を持つ:
 223 .TS
 224 tab(:);
 225 l l.
 226 RTM_F_NOTIFY:T{
 227 経路が変更されると、 rtnetlink を通してユーザーに通知が行く。
 228 T}
 229 RTM_F_CLONED:経路は他の経路によって複製された。
 230 RTM_F_EQUALIZE:マルチパスイコライザ (まだ実装されていない)
 231 .TE
 232
 233 \fIrtm_table\fP ではルーティングテーブルを指定する。
 234 .TS
 235 tab(:);
 236 l l.
 237 RT_TABLE_UNSPEC:指定されていないルーティングテーブル
 238 RT_TABLE_DEFAULT:デフォルトのテーブル
 239 RT_TABLE_MAIN:メインのテーブル
 240 RT_TABLE_LOCAL:ローカルテーブル
 241 .TE
 242
 243 .\" Keep table on same page
 244 ユーザーは \fBRT_TABLE_UNSPEC\fP と \fBRT_TABLE_DEFAULT\fP.  の間の任意の値を用いることができる。
 245 .bp +1
 246 .TS
 247 tab(:);
 248 c s s
 249 l l l.
 250 属性
 251 rta_type:値の型:説明
 252 _
 253 RTA_UNSPEC:\-:無視される
 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:経路の優先度
 260 RTA_PREFSRC::
 261 RTA_METRICS:int:経路のメトリック
 262 RTA_MULTIPATH::
 263 RTA_PROTOINFO::
 264 RTA_FLOW::
 265 RTA_CACHEINFO::
 266 .TE
 267
 268 \fB(これらの値を埋めること!)\fP
 269 .TP
 270 \fBRTM_NEWNEIGH\fP, \fBRTM_DELNEIGH\fP, \fBRTM_GETNEIGH\fP
 271 近傍テーブル (neighbor table) のエントリ (例えば ARP エントリ) の情報を追加・削除・取得する。 このメッセージは
 272 \fIndmsg\fP 構造体を伴う。
 273
 274 .nf
 275 struct ndmsg {
 276     unsigned char ndm_family;
 277     int           ndm_ifindex;  /* Interface index */
 278     __u16         ndm_state;    /* State */
 279     __u8          ndm_flags;    /* Flags */
 280     __u8          ndm_type;
 281 };
 282
 283 struct nda_cacheinfo {
 284     __u32         ndm_confirmed;
 285     __u32         ndm_used;
 286     __u32         ndm_updated;
 287     __u32         ndm_refcnt;
 288 };
 289 .fi
 290
 291 \fIndm_state\fP は以下の状態のビットマスクである:
 292 .TS
 293 tab(:);
 294 l l.
 295 NUD_INCOMPLETE:現在レゾルブ中のキャッシュエントリ
 296 NUD_REACHABLE:動作確認済みのキャッシュエントリ
 297 NUD_STALE:期限切れのキャッシュエントリ
 298 NUD_DELAY:タイマ待ちのキャッシュエントリ
 299 NUD_PROBE:再確認中のキャッシュエントリ
 300 NUD_FAILED:不正なキャッシュエントリ
 301 NUD_NOARP:行き先キャッシュのないデバイス
 302 NUD_PERMANENT:静的なエントリ
 303 .TE
 304
 305 有効な \fIndm_flags\fP は以下の通り:
 306 .TS
 307 tab(:);
 308 l l.
 309 NTF_PROXY:プロクシ arp エントリ
 310 NTF_ROUTER:IPv6 ルータ
 311 .TE
 312
 313 .\" FIXME
 314 .\" document the members of the struct better
 315 \fIrtattr\fP 構造体は、 \fIrta_type\fP フィールドに応じてそれぞれ以下の意味を持つ:
 316 .TS
 317 tab(:);
 318 l l.
 319 NDA_UNSPEC:未知のタイプ
 320 NDA_DST:近傍キャッシュネットワーク層の行き先アドレス
 321 NDA_LLADDR:近傍キャッシュリンク層のアドレス
 322 NDA_CACHEINFO:キャッシュの統計
 323 .TE
 324
 325 \fIrta_type\fP フィールドが \fBNDA_CACHEINFO\fP の場合には、 \fIstruct nda_cacheinfo\fP ヘッダが続く。
 326 .TP
 327 \fBRTM_NEWRULE\fP, \fBRTM_DELRULE\fP, \fBRTM_GETRULE\fP
 328 ルーティングルールを追加・削除・取得する。 \fIstruct rtmsg\fP を伴う。
 329 .TP
 330 \fBRTM_NEWQDISC\fP, \fBRTM_DELQDISC\fP, \fBRTM_GETQDISC\fP
 331 キューイングルールを追加・削除・取得する。 このメッセージは \fIstruct tcmsg\fP を伴い、またそのあとに属性がいくつか続くこともある。
 332
 333 .nf
 334 struct tcmsg {
 335     unsigned char    tcm_family;
 336     int              tcm_ifindex;   /* interface index */
 337     __u32            tcm_handle;    /* Qdisc handle */
 338     __u32            tcm_parent;    /* Parent qdisc */
 339     __u32            tcm_info;
 340 };
 341 .fi
 342 .TS
 343 tab(:);
 344 c s s
 345 l2 l2 l.
 346 属性
 347 rta_type:値の型:説明
 348 _
 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:レート制限
 355 .TE
 356
 357 さらに、 qdisc モジュール特有の様々な属性を指定できる。 詳細な情報は適切なインクルードファイルを見よ。
 358 .TP
 359 \fBRTM_NEWTCLASS\fP, \fBRTM_DELTCLASS\fP, \fBRTM_GETTCLASS\fP
 360 トラフィッククラスを追加・削除・取得する。 これらのメッセージは、上述の \fIstruct tcmsg\fP を伴う。
 361 .TP
 362 \fBRTM_NEWTFILTER\fP, \fBRTM_DELTFILTER\fP, \fBRTM_GETTFILTER\fP
 363 トラフィックフィルターの情報を追加・削除・取得する。 これらのメッセージは、上述の \fIstruct tcmsg\fP を伴う。
 364 .SH バージョン
 365 \fBrtnetlink\fP は Linux 2.2 の新機能である。
 366 .SH バグ
 367 このマニュアルは完全ではない。
 368 .SH 関連項目
 369 \fBcmsg\fP(3), \fBrtnetlink\fP(3), \fBip\fP(7), \fBnetlink\fP(7)
 370 .SH この文書について
 371 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.65 の一部
 372 である。プロジェクトの説明とバグ報告に関する情報は
 373 http://www.kernel.org/doc/man\-pages/ に書かれている。