2 .\" This man page is Copyright (c) 1998 by Andi Kleen.
4 .\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
5 .\" Subject to the GPL.
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 .\"*******************************************************************
13 .\" This file was generated with po4a. Translate the source file.
15 .\"*******************************************************************
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
22 .TH NETLINK 7 2015\-01\-10 Linux "Linux Programmer's Manual"
24 netlink \- カーネルとユーザー空間の通信 (AF_NETLINK)
27 \fB#include <asm/types.h>\fP
28 \fB#include <sys/socket.h>\fP
29 \fB#include <linux/netlink.h>\fP
31 \fBnetlink_socket = socket(AF_NETLINK, \fP\fIsocket_type\fP\fB, \fP\fInetlink_family\fP\fB);\fP
34 netlink はカーネルモジュールとユーザー空間のプロセス間で 情報をやりとりするために用いられる。 netlink は、ユーザープロセスに対しては
35 標準的なソケットベースのインターフェースを、 カーネルモジュールにはカーネルの内部 API を提供する。 カーネル内部のインターフェースについてはこの
36 man ページでは記述しない。 また、netlink キャラクタデバイスを用いた obsolete な netlink
37 インターフェースもあるが、これもこの文書では解説しない。 これは過去互換性のためだけに用意されている。
39 netlink はデータグラム指向のサービスである。 \fIsocket_type\fP には \fBSOCK_RAW\fP と \fBSOCK_DGRAM\fP
40 の両方とも指定可能である。 しかし netlink プロトコルはデータグラムと raw ソケットの区別をしない。
42 \fInetlink_family\fP は、通信するカーネルモジュールや netlink グループの選択に用いる。 現在割り当てられている netlink
46 ルーティングとリンクの更新を受信する。 (IPv4 と IPv6 両方の) ルーティングテーブル・ IP アドレス・リンクパラメータ・近傍設定
47 (neighbor setup)・ キューイングルール (queueing dicipline)・トラフィッククラス・
48 パケットのクラス分類の修正に用いることができるだろう (\fBrtnetlink\fP(7) を見よ)。
51 単線 (1\-wire) のサブシステムからのメッセージ。
53 \fBNETLINK_USERSOCK\fP
54 ユーザーモードソケットプロトコルのために予約されている。
56 \fBNETLINK_FIREWALL\fP
57 IPv4 パケットを netfilter からユーザー空間へ転送する。 \fIip_queue\fP カーネルモジュールで使用される。
59 \fBNETLINK_INET_DIAG\fP
60 .\" FIXME More details on NETLINK_INET_DIAG needed.
64 Netfilter/iptables ULOG.
67 .\" FIXME More details on NETLINK_XFRM needed.
74 .\" FIXME More details on NETLINK_ISCSI needed.
78 .\" FIXME More details on NETLINK_AUDIT needed.
81 \fBNETLINK_FIB_LOOKUP\fP
82 .\" FIXME More details on NETLINK_FIB_LOOKUP needed.
83 ユーザー空間から FIB ルックアップにアクセスする。
85 \fBNETLINK_CONNECTOR\fP
86 カーネルコネクタ。より詳しい情報は Linux カーネルソースの \fIDocumentation/connector/*\fP を参照すること。
88 \fBNETLINK_NETFILTER\fP
89 .\" FIXME More details on NETLINK_NETFILTER needed.
93 IPv6 パケットを netfilter からユーザー空間へ転送する。 \fIip6_queue\fP カーネルモジュールで使用される。
98 \fBNETLINK_KOBJECT_UEVENT\fP
99 .\" FIXME More details on NETLINK_KOBJECT_UEVENT needed.
102 \fBNETLINK_GENERIC\fP
103 netlink を簡単に使用するための一般的な netlink ファミリー。
105 \fBNETLINK_CRYPTO\fP (Linux 3.2 以降)
106 .\" commit a38f7907b926e4c6c7d389ad96cc38cec2e5a9e9
107 .\" Author: Steffen Klassert <steffen.klassert@secunet.com>
108 カーネル暗号 API で登録された暗号に関する情報を要求したり、 カーネル暗号 API の設定を行ったりするための netlink インターフェース。
110 netlink メッセージはバイトストリームからなり、 一つ以上の \fInlmsghdr\fP ヘッダと、それに対応するペイロード (payload)
111 が含まれる。 バイトストリームには、標準の \fBNLMSG_*\fP マクロによってのみアクセスすべきである。 より詳しい情報は \fBnetlink\fP(3)
114 マルチパートメッセージ (一つ以上の \fInlmsghdr\fP ヘッダと、それに対応するペイロードが 一つバイトストリームに含まれる) においては、
115 先頭のヘッダ・後続のヘッダには \fBNLM_F_MULTI\fP フラグがセットされる。ただし最後のヘッダだけは例外で、 \fBNLMSG_DONE\fP
118 それぞれの \fBnlmsghdr\fP の後にはペイロードが続く。
123 __u32 nlmsg_len; /* ヘッダを含むメッセージの長さ */
124 __u16 nlmsg_type; /* メッセージの内容のタイプ */
125 __u16 nlmsg_flags; /* 追加フラグ */
126 __u32 nlmsg_seq; /* シーケンス番号 */
127 __u32 nlmsg_pid; /* 送信者のポート ID */
132 \fInlmsg_type\fP は標準のメッセージタイプのどれか一つである: \fBNLMSG_NOOP\fP メッセージは無視される。
133 \fBNLMSG_ERROR\fP メッセージはエラーを示し、ペイロードには \fInlmsgerr\fP 構造体が入る。 \fBNLMSG_DONE\fP
134 メッセージはマルチパートメッセージの終了を伝える。
139 int error; /* 負または 0 の errno は応答を表す */
140 struct nlmsghdr msg; /* エラーを起こしたメッセージのヘッダ */
145 ある netlink ファミリーで指定できるメッセージタイプは、 通常もっと多い。これらに関しては適切な man ページを見てほしい。 たとえば
146 \fBNETLINK_ROUTE\fP に関しては \fBrtnetlink\fP(7) に書いてある。
151 \fInlmsg_flags\fP の標準フラグビット
153 NLM_F_REQUEST:要求メッセージ全てでセットされなければならない。
155 このメッセージはマルチパートメッセージの一部である。
156 マルチパートメッセージは \fBNLMSG_DONE\fP で終端する。
158 NLM_F_ACK:成功した場合の応答を要求する。
159 NLM_F_ECHO:この要求をエコーする。
162 .\" No right adjustment for text blocks in tables
169 NLM_F_ROOT:単一のエントリではなくテーブル全体を返す。
171 メッセージの内容で渡された基準 (criteria) にマッチする全てのエントリを返す。
174 .\" FIXME NLM_F_ATOMIC is not used anymore?
175 NLM_F_ATOMIC:テーブルのアトミックなスナップショットを返す。
179 (NLM_F_ROOT|NLM_F_MATCH) と等価.
183 \fBNLM_F_ATOMIC\fP を使う場合は、 \fBCAP_NET_ADMIN\fP 権限を持つか実効ユーザー ID が 0
191 NLM_F_REPLACE:現存のオブジェクトを置換する。
192 NLM_F_EXCL:すでにオブジェクトがあったら置換しない。
193 NLM_F_CREATE:まだオブジェクトがなければ作成する。
194 NLM_F_APPEND:オブジェクトリストの最後に追加する。
197 \fInlmsg_seq\fP と \fInlmsg_pid\fP はメッセージの追跡に使用される。 \fInlmsg_pid\fP はメッセージの送信元を表す。
198 メッセージが netlink ソケットで送信されている場合、 \fInlmsg_pid\fP とプロセスの PID は 1:1
199 の関係ではない点に注意すること。 より詳しい情報は、 「\fBアドレスのフォーマット\fP」 のセクションを参照すること。
201 .\" FIXME Explain more about nlmsg_seq and nlmsg_pid.
202 \fInlmsg_seq\fP と \fInlmsg_pid\fP は netlink のコアには見えない (opaque)。
204 netlink は信頼性の高いプロトコルではない。 netlink はメッセージを行き先に届けるために最善を尽くすが、
205 メモリが足りなかったりエラーが起こったりすると メッセージを取りこぼすこともある。 信頼性の高い転送を行いたいときは、
206 送信者は受信者に応答を要求することもできる。 これには \fBNLM_F_ACK\fP フラグをセットする。 応答は \fBNLMSG_ERROR\fP
207 パケットのエラーフィールドを 0 にしたものになる。 アプリケーションは自分自身のメッセージを受けたときには、 応答を生成しなければならない。
208 カーネルは失敗したパケットに対して、 \fBNLMSG_ERROR\fP メッセージを送ろうとする。 ユーザープロセスはこの慣習にも従う必要がある。
210 しかし、どのような場合でもカーネルからユーザーへの 信頼性の高い転送は不可能である。 ソケットバッファが満杯の場合、カーネルは netlink
211 メッセージを送信できない。 メッセージは取りこぼされて、カーネルとユーザー空間プロセスは、 カーネルの状態についての同じビューを持つことができなくなる。
212 これが起こったこと (\fBrecvmsg\fP(2) によって \fBENOBUFS\fP エラーが返される) を検知して再び同期させるのは、
215 \fIsockaddr_nl\fP 構造体はユーザー空間やカーネル空間で netlink クライアントを記述する。 \fIsockaddr_nl\fP
216 はユニキャスト (単一の接続先にだけ送られる) にもできるし、 netlink マルチキャストグループ (\fInl_groups\fP が 0 でない場合)
222 sa_family_t nl_family; /* AF_NETLINK */
223 unsigned short nl_pad; /* 0 である */
224 pid_t nl_pid; /* ポート ID */
225 __u32 nl_groups; /* マルチキャストグループマスク */
230 \fInl_pid\fP は netlink ソケットのユニキャストアドレスである。 行き先がカーネルの場合は、常に 0 である。
231 ユーザー空間プロセスの場合、通常は \fInl_pid\fP は行き先のソケットを所有しているプロセスの PID である。 ただし、 \fInl_pid\fP
232 はプロセスではなく netlink ソケットを同定する。 プロセスが複数の netlink ソケットを所有する場合、 \fInl_pid\fP
233 は最大でも一つのソケットのプロセス ID としか等しくならない。 \fInl_pid\fP を netlink ソケットに割り当てる方法は 2 つある。
234 アプリケーションが \fBbind\fP(2) を呼ぶ前に \fInl_pid\fP を設定する場合、 \fInl_pid\fP
235 が一意であることを確認するのはアプリケーションの責任となる。 アプリケーションが \fInl_pid\fP を 0
236 に設定した場合、カーネルがこの値を割り当てる。 カーネルはプロセスが最初にオープンした netlink ソケットに対してプロセス ID を割り当て、
237 それ以降にプロセスが作成した全ての netlink ソケットにも一意な \fInl_pid\fP を割り当てる。
239 .\" commit d629b836d151d43332492651dd841d32e57ebe3b
240 \fInl_groups\fP はビットマスクで、すべてのビットが netlink グループ番号を表す。
241 それぞれの netlink ファミリーは 32 のマルチキャストグループのセットを持つ。
242 それぞれの netlink ファミリーは 32 のマルチキャストグループの セットを持つ。
243 \fBbind\fP(2) がソケットに対して呼ばれると、 \fIsockaddr_nl\fP の \fInl_groups\fP
244 フィールドには listen したいグループのビットマスクがセットされる。
245 デフォルトの値は 0 で、マルチキャストを一切受信しない。
246 \fBsendmsg\fP(2) や \fBconnect\fP(2) によって、あるソケットからメッセージを
247 マルチキャストしたいときは、 \fInl_groups\fP に送信したいグループのビットマスク
249 netlink マルチキャストグループに送信したり、これを listen したりできるのは、
250 実効ユーザー ID が 0 のプロセスか、 \fBCAP_NET_ADMIN\fP 権限を持つプロセスのみである。
251 Linux 2.6.13 以降では、メッセージを複数のグループへのブロードキャストすることはできない。
252 マルチキャストグループ向けメッセージを受信した場合、これ対する応答は
253 送り主の PID とマルチキャストグループとに送り返すべきである。
254 さらに、Linux のカーネルサブシステムによっては、
255 他のユーザもメッセージの送受信ができる場合がある。
257 \fBNETLINK_KOBJECT_UEVENT\fP, \fBNETLINK_GENERIC\fP, \fBNETLINK_ROUTE\fP,
258 \fBNETLINK_SELINUX\fP グループでは他のユーザがメッセージを受信することができる。
259 他のユーザがメッセージを送信できるグループは存在しない。
261 netlink へのソケットインターフェースは Linux 2.2 の新機能である。
263 Linux 2.0 は、もっと原始的なデバイスベースの netlink インターフェースを サポートしていた (これも互換性のために今でも使用できる)。
264 古いインターフェースに関してはここでは記述しない。
266 NETLINK_SELINUX は Linux 2.6.4 で登場した。
268 NETLINK_AUDIT は Linux 2.6.6 で登場した。
270 NETLINK_KOBJECT_UEVENT は Linux 2.6.10 で登場した。
272 NETLINK_W1, NETLINK_FIB_LOOKUP は Linux 2.6.13 で登場した。
274 NETLINK_INET_DIAG, NETLINK_CONNECTOR, NETLINK_NETFILTER は Linux 2.6.14
277 NETLINK_GENERIC, NETLINK_ISCSI は Linux 2.6.15 で登場した。
279 低レベルのカーネルインターフェースより、 \fIlibnetlink\fP または \fIlibnl\fP を通して netlink
284 以下の例では、 \fBRTMGRP_LINK\fP (ネットワークインターフェースの create/delete/up/down イベント) と
285 \fBRTMGRP_IPV4_IFADDR\fP (IPv4 アドレスの add/delete イベント) マルチキャストグループを listen する
286 \fBNETLINK_ROUTE\fP netlink を作成している。
290 struct sockaddr_nl sa;
292 memset(&sa, 0, sizeof(sa));
293 sa.nl_family = AF_NETLINK;
294 sa.nl_groups = RTMGRP_LINK | RTMGRP_IPV4_IFADDR;
296 fd = socket(AF_NETLINK, SOCK_RAW, NETLINK_ROUTE);
297 bind(fd, (struct sockaddr *) &sa, sizeof(sa));
301 次の例では、netlink メッセージをカーネル (pid 0) に送る方法を示している。 応答を追跡する際の信頼性を高めるために、アプリケーションが
302 メッセージのシーケンス番号を正しく処理しなければならない点に注意すること。
306 struct nlmsghdr *nh; /* 送信する nlmsghdr とペイロード */
307 struct sockaddr_nl sa;
308 struct iovec iov = { nh, nh\->nlmsg_len };
311 msg = { &sa, sizeof(sa), &iov, 1, NULL, 0, 0 };
312 memset(&sa, 0, sizeof(sa));
313 sa.nl_family = AF_NETLINK;
315 nh\->nlmsg_seq = ++sequence_number;
316 /* NLM_F_ACK を設定することで、カーネルに応答を要求する */
317 nh\->nlmsg_flags |= NLM_F_ACK;
319 sendmsg(fd, &msg, 0);
323 最後は、netlink メッセージの読み込みの例である。
329 struct iovec iov = { buf, sizeof(buf) };
330 struct sockaddr_nl sa;
334 msg = { &sa, sizeof(sa), &iov, 1, NULL, 0, 0 };
335 len = recvmsg(fd, &msg, 0);
337 for (nh = (struct nlmsghdr *) buf; NLMSG_OK (nh, len);
338 nh = NLMSG_NEXT (nh, len)) {
339 /* マルチパートメッセージの終わり */
340 if (nh\->nlmsg_type == NLMSG_DONE)
343 if (nh\->nlmsg_type == NLMSG_ERROR)
353 \fBcmsg\fP(3), \fBnetlink\fP(3), \fBcapabilities\fP(7), \fBrtnetlink\fP(7)
355 .UR ftp://ftp.inr.ac.ru\:/ip\-routing\:/iproute2*
359 .UR http://people.suug.ch\:/~tgr\:/libnl/
363 RFC 3549 "Linux Netlink as an IP Services Protocol"
365 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.77 の一部
366 である。プロジェクトの説明とバグ報告に関する情報は
367 http://www.kernel.org/doc/man\-pages/ に書かれている。