release/man3/rtnetlink.3

   1 .\" This man page is Copyright (C) 1999 Andi Kleen <ak@muc.de>.
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM_ONE_PARA)
   4 .\" Permission is granted to distribute possibly modified copies
   5 .\" of this page provided the header is included verbatim,
   6 .\" and in case of nontrivial modification author and date
   7 .\" of the modification is added to the header.
   8 .\" %%%LICENSE_END
   9 .\"
  10 .\" $Id: rtnetlink.3,v 1.2 1999/05/18 10:35:10 freitag Exp $
  11 .\"
  12 .\"*******************************************************************
  13 .\"
  14 .\" This file was generated with po4a. Translate the source file.
  15 .\"
  16 .\"*******************************************************************
  17 .TH RTNETLINK 3 2012\-03\-24 GNU "Linux Programmer's Manual"
  18 .SH 名前
  19 rtnetlink \- rtnetlink メッセージを操作するマクロ
  20 .SH 書式
  21 \fB#include <asm/types.h>\fP
  22 .br
  23 \fB#include <linux/netlink.h>\fP
  24 .br
  25 \fB#include <linux/rtnetlink.h>\fP
  26 .br
  27 \fB#include <sys/socket.h>\fP
  28
  29 \fBrtnetlink_socket = socket(AF_NETLINK, int \fP\fIsocket_type\fP\fB,
  30 NETLINK_ROUTE);\fP
  31 .sp
  32 \fBint RTA_OK(struct rtattr *\fP\fIrta\fP\fB, int \fP\fIrtabuflen\fP\fB);\fP
  33 .sp
  34 \fBvoid *RTA_DATA(struct rtattr *\fP\fIrta\fP\fB);\fP
  35 .sp
  36 \fBunsigned int RTA_PAYLOAD(struct rtattr *\fP\fIrta\fP\fB);\fP
  37 .sp
  38 \fBstruct rtattr *RTA_NEXT(struct rtattr *\fP\fIrta\fP\fB, unsigned int
  39 \fP\fIrtabuflen\fP\fB);\fP
  40 .sp
  41 \fBunsigned int RTA_LENGTH(unsigned int \fP\fIlength\fP\fB);\fP
  42 .sp
  43 \fBunsigned int RTA_SPACE(unsigned int \fP\fIlength\fP\fB);\fP
  44 .SH 説明
  45 全ての \fBrtnetlink\fP(7)  メッセージは \fBnetlink\fP(7)  メッセージヘッダと追加属性からなる。
  46 属性の操作は、必ずここに挙げたマクロだけを使って行うべきである。
  47 .PP
  48 \fBRTA_OK(\fP\fIrta\fP\fB, \fP\fIattrlen\fP\fB)\fP は \fIrta\fP が有効なルーティング属性へのポインタであれば真を返す。
  49 \fIattrlen\fP は属性バッファの実働時の長さ (running length) である。 真でなければ、例え \fIattrlen\fP
  50 がゼロでなくても、 メッセージ中にはもうそれ以上属性は無いと考えなければならない。
  51 .PP
  52 \fBRTA_DATA(\fP\fIrta\fP\fB)\fP はこの属性データの先頭へのポインタを返す。
  53 .PP
  54 \fBRTA_PAYLOAD(\fP\fIrta\fP\fB)\fP はこの属性データの長さを返す。
  55 .PP
  56 \fBRTA_NEXT(\fP\fIrta\fP\fB, \fP\fIattrlen\fP\fB)\fP は \fIrta\fP の次にある属性を取得する。 このマクロを呼ぶと
  57 \fIattrlen\fP が更新される。 \fBRTA_OK\fP を使って、返されたポインタが正しいかをチェックすべきである。
  58 .PP
  59 \fBRTA_LENGTH(\fP\fIlen\fP\fB)\fP は \fIlen\fP バイトのデータ + ヘッダに必要な長さを返す。
  60 .PP
  61 \fBRTA_SPACE(\fP\fIlen\fP\fB)\fP は \fIlen\fP バイトのデータを持つメッセージに必要とされる容量を返す。
  62 .SH 準拠
  63 これらのマクロは非標準で、Linux での拡張である。
  64 .SH バグ
  65 このマニュアルは完全ではない。
  66 .SH 例
  67
  68 .\" FIXME ? would be better to use libnetlink in the EXAMPLE code here
  69 デバイスの MTU をセットする rtnetlink メッセージを生成する
  70 .nf
  71     #include <linux/rtnetlink.h>
  72
  73     ...
  74
  75     struct {
  76         struct nlmsghdr  nh;
  77         struct ifinfomsg if;
  78         char             attrbuf[512];
  79     } req;
  80
  81     struct rtattr *rta;
  82     unsigned int mtu = 1000;
  83
  84     int rtnetlink_sk = socket(AF_NETLINK, SOCK_DGRAM, NETLINK_ROUTE);
  85
  86     memset(&req, 0, sizeof(req));
  87     req.nh.nlmsg_len = NLMSG_LENGTH(sizeof(struct ifinfomsg));
  88     req.nh.nlmsg_flags = NLM_F_REQUEST;
  89     req.nh.nlmsg_type = RTM_NEWLINK;
  90     req.if.ifi_family = AF_UNSPEC;
  91     req.if.ifi_index = INTERFACE_INDEX;
  92     req.if.ifi_change = 0xffffffff; /* ??? */
  93     rta = (struct rtattr *)(((char *) &req) +
  94                              NLMSG_ALIGN(req.nh.nlmsg_len));
  95     rta\->rta_type = IFLA_MTU;
  96     rta\->rta_len = RTA_LENGTH(sizeof(unsigned int));
  97     req.n.nlmsg_len = NLMSG_ALIGN(req.nh.nlmsg_len) +
  98                                   RTA_LENGTH(sizeof(mtu));
  99     memcpy(RTA_DATA(rta), &mtu, sizeof(mtu));
 100     send(rtnetlink_sk, &req, req.nh.nlmsg_len);
 101 .fi
 102 .SH 関連項目
 103 \fBnetlink\fP(3), \fBnetlink\fP(7), \fBrtnetlink\fP(7)
 104 .SH この文書について
 105 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
 106 である。プロジェクトの説明とバグ報告に関する情報は
 107 http://www.kernel.org/doc/man\-pages/ に書かれている。