draft/man7/netlink.7

   1 .\" t
   2 .\" This man page is Copyright (c) 1998 by Andi Kleen.
   3 .\"
   4 .\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
   5 .\" Subject to the GPL.
   6 .\" %%%LICENSE_END
   7 .\"
   8 .\" Based on the original comments from Alexey Kuznetsov
   9 .\" Modified 2005-12-27 by Hasso Tepper <hasso@estpak.ee>
  10 .\" $Id: netlink.7,v 1.8 2000/06/22 13:23:00 ak Exp $
  11 .\"*******************************************************************
  12 .\"
  13 .\" This file was generated with po4a. Translate the source file.
  14 .\"
  15 .\"*******************************************************************
  16 .\"
  17 .\" Japanese Version Copyright (c) 1999 NAKANO Takeo all rights reserved.
  18 .\" Translated 1999-12-06 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
  19 .\" Updated 2001-04-04 by Yuichi SATO <ysato@h4.dion.ne.jp>, catch up to LDP v1.35
  20 .\" Updated 2006-06-23 by Yuichi SATO <ysato444@yahoo.co.jp>, catch up to LDP v2.29
  21 .\"
  22 .TH NETLINK 7 2013\-03\-15 Linux "Linux Programmer's Manual"
  23 .SH 名前
  24 netlink \- カーネルとユーザー空間の通信 (AF_NETLINK)
  25 .SH 書式
  26 .nf
  27 \fB#include <asm/types.h>\fP
  28 \fB#include <sys/socket.h>\fP
  29 \fB#include <linux/netlink.h>\fP
  30
  31 \fBnetlink_socket = socket(AF_NETLINK, \fP\fIsocket_type\fP\fB, \fP\fInetlink_family\fP\fB);\fP
  32 .fi
  33 .SH 説明
  34 netlink はカーネルモジュールとユーザー空間のプロセス間で 情報をやりとりするために用いられる。 netlink は、ユーザープロセスに対しては
  35 標準的なソケットベースのインターフェースを、 カーネルモジュールにはカーネルの内部 API を提供する。 カーネル内部のインターフェースについてはこの
  36 man ページでは記述しない。 また、netlink キャラクタデバイスを用いた obsolete な netlink
  37 インターフェースもあるが、これもこの文書では解説しない。 これは過去互換性のためだけに用意されている。
  38
  39 netlink はデータグラム指向のサービスである。 \fIsocket_type\fP には \fBSOCK_RAW\fP と \fBSOCK_DGRAM\fP
  40 の両方とも指定可能である。 しかし netlink プロトコルはデータグラムと raw ソケットの区別をしない。
  41
  42 \fInetlink_family\fP は、通信するカーネルモジュールや netlink グループの選択に用いる。 現在割り当てられている netlink
  43 ファミリーは以下の通り。
  44 .TP
  45 \fBNETLINK_ROUTE\fP
  46 ルーティングとリンクの更新を受信する。 (IPv4 と IPv6 両方の) ルーティングテーブル・ IP アドレス・リンクパラメータ・近傍設定
  47 (neighbor setup)・ キューイングルール (queueing dicipline)・トラフィッククラス・
  48 パケットのクラス分類の修正に用いることができるだろう (\fBrtnetlink\fP(7)  を見よ)。
  49 .TP
  50 \fBNETLINK_W1\fP
  51 単線 (1\-wire) のサブシステムからのメッセージ。
  52 .TP
  53 \fBNETLINK_USERSOCK\fP
  54 ユーザーモードソケットプロトコルのために予約されている。
  55 .TP
  56 \fBNETLINK_FIREWALL\fP
  57 IPv4 パケットを netfilter からユーザー空間へ転送する。 \fIip_queue\fP カーネルモジュールで使用される。
  58 .TP
  59 \fBNETLINK_INET_DIAG\fP
  60 .\" FIXME More details on NETLINK_INET_DIAG needed.
  61 INET ソケットをモニタリングする。
  62 .TP
  63 \fBNETLINK_NFLOG\fP
  64 Netfilter/iptables ULOG.
  65 .TP
  66 \fBNETLINK_XFRM\fP
  67 .\" FIXME More details on NETLINK_XFRM needed.
  68 IPsec.
  69 .TP
  70 \fBNETLINK_SELINUX\fP
  71 SELinux のイベント通知。
  72 .TP
  73 \fBNETLINK_ISCSI\fP
  74 .\" FIXME More details on NETLINK_ISCSI needed.
  75 Open\-iSCSI.
  76 .TP
  77 \fBNETLINK_AUDIT\fP
  78 .\" FIXME More details on NETLINK_AUDIT needed.
  79 監査 (audit) を行う。
  80 .TP
  81 \fBNETLINK_FIB_LOOKUP\fP
  82 .\" FIXME More details on NETLINK_FIB_LOOKUP needed.
  83 ユーザー空間から FIB ルックアップにアクセスする。
  84 .TP
  85 \fBNETLINK_CONNECTOR\fP
  86 カーネルコネクタ。より詳しい情報は Linux カーネルソースの \fIDocumentation/connector/*\fP を参照すること。
  87 .TP
  88 \fBNETLINK_NETFILTER\fP
  89 .\" FIXME More details on NETLINK_NETFILTER needed.
  90 netfilter サブシステム。
  91 .TP
  92 \fBNETLINK_IP6_FW\fP
  93 IPv6 パケットを netfilter からユーザー空間へ転送する。 \fIip6_queue\fP カーネルモジュールで使用される。
  94 .TP
  95 \fBNETLINK_DNRTMSG\fP
  96 DECnet ルーティングメッセージ。
  97 .TP
  98 \fBNETLINK_KOBJECT_UEVENT\fP
  99 .\" FIXME More details on NETLINK_KOBJECT_UEVENT needed.
 100 ユーザー空間へのカーネルメッセージ
 101 .TP
 102 \fBNETLINK_GENERIC\fP
 103 netlink を簡単に使用するための一般的な netlink ファミリー。
 104 .PP
 105 netlink メッセージはバイトストリームからなり、 一つ以上の \fInlmsghdr\fP ヘッダと、それに対応するペイロード (payload)
 106 が含まれる。 バイトストリームには、標準の \fBNLMSG_*\fP マクロによってのみアクセスすべきである。 より詳しい情報は \fBnetlink\fP(3)
 107 を見よ。
 108
 109 マルチパートメッセージ (一つ以上の \fInlmsghdr\fP ヘッダと、それに対応するペイロードが 一つバイトストリームに含まれる) においては、
 110 先頭のヘッダ・後続のヘッダには \fBNLM_F_MULTI\fP フラグがセットされる。ただし最後のヘッダだけは例外で、 \fBNLMSG_DONE\fP
 111 タイプとなる。
 112
 113 それぞれの \fBnlmsghdr\fP の後にはペイロードが続く。
 114
 115 .in +4n
 116 .nf
 117 struct nlmsghdr {
 118     __u32 nlmsg_len;    /* ヘッダを含むメッセージの長さ */
 119     __u16 nlmsg_type;   /* メッセージの内容のタイプ */
 120     __u16 nlmsg_flags;  /* 追加フラグ */
 121     __u32 nlmsg_seq;    /* シーケンス番号 */
 122     __u32 nlmsg_pid;    /* 送信者のポート ID */
 123 };
 124 .fi
 125 .in
 126
 127 \fInlmsg_type\fP は標準のメッセージタイプのどれか一つである: \fBNLMSG_NOOP\fP メッセージは無視される。
 128 \fBNLMSG_ERROR\fP メッセージはエラーを示し、ペイロードには \fInlmsgerr\fP 構造体が入る。 \fBNLMSG_DONE\fP
 129 メッセージはマルチパートメッセージの終了を伝える。
 130
 131 .in +4n
 132 .nf
 133 struct nlmsgerr {
 134     int error;        /* 負または 0 の errno は応答を表す */
 135     struct nlmsghdr msg;  /* エラーを起こしたメッセージのヘッダ */
 136 };
 137 .fi
 138 .in
 139
 140 ある netlink ファミリーで指定できるメッセージタイプは、 通常もっと多い。これらに関しては適切な man ページを見てほしい。 たとえば
 141 \fBNETLINK_ROUTE\fP に関しては \fBrtnetlink\fP(7)  に書いてある。
 142 .TS
 143 tab(:);
 144 l s
 145 lB l.
 146 \fInlmsg_flags\fP の標準フラグビット
 147 _
 148 NLM_F_REQUEST:要求メッセージ全てでセットされなければならない。
 149 NLM_F_MULTI:T{
 150 このメッセージはマルチパートメッセージの一部である。
 151 マルチパートメッセージは \fBNLMSG_DONE\fP で終端する。
 152 T}
 153 NLM_F_ACK:成功した場合の応答を要求する。
 154 NLM_F_ECHO:この要求をエコーする。
 155 .TE
 156 .ad
 157 .sp 1
 158 .\" No right adjustment for text blocks in tables
 159 .na
 160 .TS
 161 tab(:);
 162 l s
 163 lB l.
 164 GET 要求における追加フラグビット
 165 _
 166 NLM_F_ROOT:単一のエントリではなくテーブル全体を返す。
 167 NLM_F_MATCH:T{
 168 メッセージの内容で渡された基準 (criteria) にマッチする全てのエントリを返す。
 169 まだ実装されていない。
 170 T}
 171 .\" FIXME NLM_F_ATOMIC is not used any more?
 172 NLM_F_ATOMIC:テーブルのアトミックなスナップショットを返す。
 173 NLM_F_DUMP:T{
 174 便利なマクロ。(NLM_F_ROOT|NLM_F_MATCH) と同じ。
 175 T}
 176 .TE
 177 .ad
 178 .sp 1
 179 \fBNLM_F_ATOMIC\fP を使う場合は、 \fBCAP_NET_ADMIN\fP 権限を持つか実効ユーザー ID が 0
 180 でなければならない点に注意すること。
 181 .na
 182 .TS
 183 tab(:);
 184 l s
 185 lB l.
 186 NEW 要求における追加フラグビット
 187 _
 188 NLM_F_REPLACE:現存のオブジェクトを置換する。
 189 NLM_F_EXCL:すでにオブジェクトがあったら置換しない。
 190 NLM_F_CREATE:まだオブジェクトがなければ作成する。
 191 NLM_F_APPEND:オブジェクトリストの最後に追加する。
 192 .TE
 193 .ad
 194 .sp 1
 195 \fInlmsg_seq\fP と \fInlmsg_pid\fP はメッセージの追跡に使用される。 \fInlmsg_pid\fP はメッセージの送信元を表す。
 196 メッセージが netlink ソケットで送信されている場合、 \fInlmsg_pid\fP とプロセスの PID は 1:1
 197 の関係ではない点に注意すること。 より詳しい情報は、 「\fBアドレスのフォーマット\fP」 のセクションを参照すること。
 198
 199 .\" FIXME Explain more about nlmsg_seq and nlmsg_pid.
 200 \fInlmsg_seq\fP と \fInlmsg_pid\fP は netlink のコアには見えない (opaque)。
 201
 202 netlink は信頼性の高いプロトコルではない。 netlink はメッセージを行き先に届けるために最善を尽くすが、
 203 メモリが足りなかったりエラーが起こったりすると メッセージを取りこぼすこともある。 信頼性の高い転送を行いたいときは、
 204 送信者は受信者に応答を要求することもできる。 これには \fBNLM_F_ACK\fP フラグをセットする。 応答は \fBNLMSG_ERROR\fP
 205 パケットのエラーフィールドを 0 にしたものになる。 アプリケーションは自分自身のメッセージを受けたときには、 応答を生成しなければならない。
 206 カーネルは失敗したパケットに対して、 \fBNLMSG_ERROR\fP メッセージを送ろうとする。 ユーザープロセスはこの慣習にも従う必要がある。
 207
 208 しかし、どのような場合でもカーネルからユーザーへの 信頼性の高い転送は不可能である。 ソケットバッファが満杯の場合、カーネルは netlink
 209 メッセージを送信できない。 メッセージは取りこぼされて、カーネルとユーザー空間プロセスは、 カーネルの状態についての同じビューを持つことができなくなる。
 210 これが起こったこと (\fBrecvmsg\fP(2)  によって \fBENOBUFS\fP エラーが返される) を検知して再び同期させるのは、
 211 アプリケーションの責任である。
 212 .SS アドレスのフォーマット
 213 \fIsockaddr_nl\fP 構造体はユーザー空間やカーネル空間で netlink クライアントを記述する。 \fIsockaddr_nl\fP
 214 はユニキャスト (単一の接続先にだけ送られる) にもできるし、 netlink マルチキャストグループ (\fInl_groups\fP が 0 でない場合)
 215 にも送ることができる。
 216
 217 .in +4n
 218 .nf
 219 struct sockaddr_nl {
 220     sa_family_t     nl_family;  /* AF_NETLINK */
 221     unsigned short  nl_pad;     /* 0 である */
 222     pid_t           nl_pid;     /* ポート ID */
 223     __u32           nl_groups;  /* マルチキャストグループマスク */
 224 };
 225 .fi
 226 .in
 227
 228 \fInl_pid\fP は netlink ソケットのユニキャストアドレスである。 行き先がカーネルの場合は、常に 0 である。
 229 ユーザー空間プロセスの場合、通常は \fInl_pid\fP は行き先のソケットを所有しているプロセスの PID である。 ただし、 \fInl_pid\fP
 230 はプロセスではなく netlink ソケットを同定する。 プロセスが複数の netlink ソケットを所有する場合、 \fInl_pid\fP
 231 は最大でも一つのソケットのプロセス ID としか等しくならない。 \fInl_pid\fP を netlink ソケットに割り当てる方法は 2 つある。
 232 アプリケーションが \fBbind\fP(2)  を呼ぶ前に \fInl_pid\fP を設定する場合、 \fInl_pid\fP
 233 が一意であることを確認するのはアプリケーションの責任となる。 アプリケーションが \fInl_pid\fP を 0
 234 に設定した場合、カーネルがこの値を割り当てる。 カーネルはプロセスが最初にオープンした netlink ソケットに対してプロセス ID を割り当て、
 235 それ以降にプロセスが作成した全ての netlink ソケットにも一意な \fInl_pid\fP を割り当てる。
 236
 237 .\" commit d629b836d151d43332492651dd841d32e57ebe3b
 238 \fInl_groups\fP はビットマスクで、すべてのビットが netlink グループ番号を表す。
 239 それぞれの netlink ファミリーは 32 のマルチキャストグループのセットを持つ。
 240 それぞれの netlink ファミリーは 32 のマルチキャストグループの セットを持つ。
 241 \fBbind\fP(2) がソケットに対して呼ばれると、 \fIsockaddr_nl\fP の \fInl_groups\fP
 242 フィールドには listen したいグループのビットマスクがセットされる。
 243 デフォルトの値は 0 で、マルチキャストを一切受信しない。
 244 \fBsendmsg\fP(2) や \fBconnect\fP(2) によって、あるソケットからメッセージを
 245 マルチキャストしたいときは、 \fInl_groups\fP に送信したいグループのビットマスク
 246 をセットすればよい。
 247 netlink マルチキャストグループに送信したり、これを listen したりできるのは、
 248 実効ユーザー ID が 0 のプロセスか、 \fBCAP_NET_ADMIN\fP 権限を持つプロセスのみである。
 249 Linux 2.6.13 以降では、メッセージを複数のグループへのブロードキャストすることはできない。
 250 マルチキャストグループ向けメッセージを受信した場合、これ対する応答は
 251 送り主の PID とマルチキャストグループとに送り返すべきである。
 252 さらに、Linux のカーネルサブシステムによっては、
 253 他のユーザもメッセージの送受信ができる場合がある。
 254 Linux 3.0 の時点では、
 255 \fBNETLINK_KOBJECT_UEVENT\fP, \fBNETLINK_GENERIC\fP, \fBNETLINK_ROUTE\fP,
 256 \fBNETLINK_SELINUX\fP グループでは他のユーザがメッセージを受信することができる。
 257 他のユーザがメッセージを送信できるグループは存在しない。
 258 .SH バージョン
 259 netlink へのソケットインターフェースは Linux 2.2 の新機能である。
 260
 261 Linux 2.0 は、もっと原始的なデバイスベースの netlink インターフェースを サポートしていた (これも互換性のために今でも使用できる)。
 262 古いインターフェースに関してはここでは記述しない。
 263
 264 NETLINK_SELINUX は Linux 2.6.4 で登場した。
 265
 266 NETLINK_AUDIT は Linux 2.6.6 で登場した。
 267
 268 NETLINK_KOBJECT_UEVENT は Linux 2.6.10 で登場した。
 269
 270 NETLINK_W1, NETLINK_FIB_LOOKUP は Linux 2.6.13 で登場した。
 271
 272 NETLINK_INET_DIAG, NETLINK_CONNECTOR, NETLINK_NETFILTER は Linux 2.6.14
 273 で登場した。
 274
 275 NETLINK_GENERIC, NETLINK_ISCSI は Linux 2.6.15 で登場した。
 276 .SH 注意
 277 低レベルのカーネルインターフェースより、 \fIlibnetlink\fP または \fIlibnl\fP を通して netlink
 278 を利用するほうが良いことが多い。
 279 .SH バグ
 280 この man ページは完成していない。
 281 .SH 例
 282 以下の例では、 \fBRTMGRP_LINK\fP (ネットワークインターフェースの create/delete/up/down イベント) と
 283 \fBRTMGRP_IPV4_IFADDR\fP (IPv4 アドレスの add/delete イベント) マルチキャストグループを listen する
 284 \fBNETLINK_ROUTE\fP netlink を作成している。
 285
 286 .in +4n
 287 .nf
 288 struct sockaddr_nl sa;
 289
 290 memset(&sa, 0, sizeof(sa));
 291 sa.nl_family = AF_NETLINK;
 292 sa.nl_groups = RTMGRP_LINK | RTMGRP_IPV4_IFADDR;
 293
 294 fd = socket(AF_NETLINK, SOCK_RAW, NETLINK_ROUTE);
 295 bind(fd, (struct sockaddr *) &sa, sizeof(sa));
 296 .fi
 297 .in
 298
 299 次の例では、netlink メッセージをカーネル (pid 0) に送る方法を示している。 応答を追跡する際の信頼性を高めるために、アプリケーションが
 300 メッセージのシーケンス番号を正しく処理しなければならない点に注意すること。
 301
 302 .in +4n
 303 .nf
 304 struct nlmsghdr *nh;    /* 送信する nlmsghdr とペイロード */
 305 struct sockaddr_nl sa;
 306 struct iovec iov = { nh, nh\->nlmsg_len };
 307 struct msghdr msg;
 308
 309 msg = { &sa, sizeof(sa), &iov, 1, NULL, 0, 0 };
 310 memset(&sa, 0, sizeof(sa));
 311 sa.nl_family = AF_NETLINK;
 312 nh\->nlmsg_pid = 0;
 313 nh\->nlmsg_seq = ++sequence_number;
 314 /* NLM_F_ACK を設定することで、カーネルに応答を要求する */
 315 nh\->nlmsg_flags |= NLM_F_ACK;
 316
 317 sendmsg(fd, &msg, 0);
 318 .fi
 319 .in
 320
 321 最後は、netlink メッセージの読み込みの例である。
 322
 323 .in +4n
 324 .nf
 325 int len;
 326 char buf[4096];
 327 struct iovec iov = { buf, sizeof(buf) };
 328 struct sockaddr_nl sa;
 329 struct msghdr msg;
 330 struct nlmsghdr *nh;
 331
 332 msg = { &sa, sizeof(sa), &iov, 1, NULL, 0, 0 };
 333 len = recvmsg(fd, &msg, 0);
 334
 335 for (nh = (struct nlmsghdr *) buf; NLMSG_OK (nh, len);
 336      nh = NLMSG_NEXT (nh, len)) {
 337     /* マルチパートメッセージの終わり */
 338     if (nh\->nlmsg_type == NLMSG_DONE)
 339         return;
 340
 341     if (nh\->nlmsg_type == NLMSG_ERROR)
 342         /* 何らかのエラー処理を行う */
 343     ...
 344
 345     /* ペイロードの解析を続ける */
 346     ...
 347 }
 348 .fi
 349 .in
 350 .SH 関連項目
 351 \fBcmsg\fP(3), \fBnetlink\fP(3), \fBcapabilities\fP(7), \fBrtnetlink\fP(7)
 352
 353 .UR ftp://ftp.inr.ac.ru\:/ip\-routing\:/iproute2*
 354 libnetlink に関する情報
 355 .UE
 356
 357 .UR http://people.suug.ch\:/~tgr\:/libnl/
 358 libnl に関する情報
 359 .UE
 360
 361 RFC 3549 "Linux Netlink as an IP Services Protocol"
 362 .SH この文書について
 363 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 364 である。プロジェクトの説明とバグ報告に関する情報は
 365 http://www.kernel.org/doc/man\-pages/ に書かれている。