Man page - netdevice(7)

Packages contains this manual

Available languages:

en fr es ja zh_TW zh_CN

Manual

NETDEVICE

名 前
書 式
説 明
ioctl
注 意
バ グ
関 連 項 目
こ の 文 書 に つ い て

名 前

netdevice - Linux ネ ッ ト ワ ー ク デ バ イ ス へ の 低 レ ベ ル ア ク セ ス

書 式

#include <sys/ioctl.h>
#include <net/if.h>

説 明

こ の man ペ ー ジ で は 、 ネ ッ ト ワ ー ク デ バ イ ス を 設 定 す る た め に 用 い る ソ ケ ッ ト イ ン タ ー フ ェ ー ス に つ い て 解 説 す る 。

Linux は ネ ッ ト ワ ー ク デ バ イ ス を 設 定 す る た め の 標 準 的 な ioctl を い く つ か 備 え て い る 。 こ れ ら は ど ん な ソ ケ ッ ト の フ ァ イ ル デ ィ ス ク リ プ タ ー に も 用 い る こ と が で き る 。 フ ァ ミ リ ー や タ イ プ は 何 で も よ い 。 こ れ ら の ioctl の ほ と ん ど は ifreq 構 造 体 を 渡 す 。

struct ifreq {
char ifr_name[IFNAMSIZ]; /* Interface name */
union {
struct sockaddr ifr_addr;
struct sockaddr ifr_dstaddr;
struct sockaddr ifr_broadaddr;
struct sockaddr ifr_netmask;
struct sockaddr ifr_hwaddr;
short ifr_flags;
int ifr_ifindex;
int ifr_metric;
int ifr_mtu;
struct ifmap ifr_map;
char ifr_slave[IFNAMSIZ];
char ifr_newname[IFNAMSIZ];
char *ifr_data;
};
};

通 常 、 ユ ー ザ ー に よ る 設 定 対 象 デ バ イ ス の 指 定 は 、 ifr_name に イ ン タ ー フ ェ ー ス の 名 前 を セ ッ ト す る こ と に よ っ て 行 う 。 他 の 構 造 体 の 全 て の メ ン バ は 、 メ モ リ ー を 共 有 す る 。

ioctl

「 特 権 が 必 要 」 と 記 述 さ れ て い る ioctl を 実 行 す る に は 、 実 効 ユ ー ザ ー ID が 0 か 、 CAP_NET_ADMIN 権 限 が 必 要 で あ る 。 こ れ が 満 た さ れ て い な い 場 合 は EPERM が 返 さ れ る 。
SIOCGIFNAME

ifr_ifindex を 受 け 取 り 、 イ ン タ ー フ ェ ー ス の 名 前 を ifr_name に 入 れ て 返 す 。 こ れ は 結 果 を ifr_name と し て 返 す 唯 一 の ioctl で あ る 。

SIOCGIFINDEX

イ ン タ ー フ ェ ー ス の interface index を 取 得 し 、 ifr_ifindex に 入 れ て 返 す 。

SIOCGIFFLAGS , SIOCSIFFLAGS

デ バ イ ス の active フ ラ グ ワ ー ド を 取 得 ま た は 設 定 す る 。 ifr_flags に は 以 下 の 値 の ビ ッ ト マ ス ク が 入 る 。

Image grohtml-4191923-1.png

active フ ラ グ ワ ー ド の 設 定 は 特 権 が 必 要 な 操 作 で あ る 。 読 み 出 し は ど ん な プ ロ セ ス か ら も 可 能 で あ る 。
SIOCGIFPFLAGS , SIOCSIFPFLAGS

デ バ イ ス の 拡 張 (プ ラ イ ベ ー ト ) フ ラ グ を 取 得 ま た は 設 定 す る 。 ifr_flags に は 以 下 の 値 の ビ ッ ト マ ス ク が 入 る 。

Image grohtml-4191923-2.png

拡 張 (プ ラ イ ベ ー ト ) イ ン タ ー フ ェ ー ス フ ラ グ の 設 定 に は 特 権 が 必 要 で あ る 。
SIOCGIFADDR , SIOCSIFADDR

ifr_addr を 用 い て デ バ イ ス の ア ド レ ス の 設 定 /取 得 を 行 う 。 イ ン タ ー フ ェ ー ス の ア ド レ ス の 設 定 は 特 権 が 必 要 な 操 作 で あ る 。 互 換 性 確 保 の た め 、 設 定 /取 得 が で き る の は AF_INET ア ド レ ス だ け で あ る 。

SIOCGIFDSTADDR , SIOCSIFDSTADDR

point-to-point デ バ イ ス の 宛 先 ア ド レ ス を ifr_dstaddr を 用 い て 設 定 /取 得 す る 。 互 換 性 確 保 の た め 、 設 定 /取 得 が で き る の は AF_INET ア ド レ ス だ け で あ る 。 宛 先 ア ド レ ス の 設 定 は 特 権 が 必 要 な 操 作 で あ る 。

SIOCGIFBRDADDR , SIOCSIFBRDADDR

デ バ イ ス の ブ ロ ー ド キ ャ ス ト ア ド レ ス を ifr_brdaddr を 用 い て 設 定 /取 得 す る 。 互 換 性 確 保 の た め 、 設 定 /取 得 が で き る の は AF_INET ア ド レ ス だ け で あ る 。 ブ ロ ー ド キ ャ ス ト ア ド レ ス の 設 定 は 特 権 が 必 要 な 操 作 で あ る 。

SIOCGIFNETMASK , SIOCSIFNETMASK

デ バ イ ス の ネ ッ ト ワ ー ク マ ス ク を ifr_netmask を 用 い て 設 定 /取 得 す る 。 互 換 性 確 保 の た め 、 設 定 /取 得 が で き る の は AF_INET ア ド レ ス だ け で あ る 。 ネ ッ ト ワ ー ク マ ス ク の 設 定 は 特 権 が 必 要 な 操 作 で あ る 。

SIOCGIFMETRIC , SIOCSIFMETRIC

デ バ イ ス の メ ト リ ッ ク を ifr_metric を 用 い て 取 得 ・ 設 定 す る 。 こ れ は ま だ 実 装 さ れ て い な い 。 読 み 出 そ う と す る と ifr_metric に 0 を セ ッ ト し て 返 り 、 設 定 し よ う と す る と EOPNOTSUPP が 返 る 。

SIOCGIFMTU , SIOCSIFMTU

デ バ イ ス の MTU (Maximum Transfer Unit) を ifr_mtu を 用 い て 取 得 ・ 設 定 す る 。 MTU の 設 定 は 特 権 が 必 要 な 操 作 で あ る 。 MTU の 値 を 小 さ く し す ぎ る と カ ー ネ ル が ク ラ ッ シ ュ す る か も し れ な い 。

SIOCGIFHWADDR , SIOCSIFHWADDR

デ バ イ ス の ハ ー ド ウ ェ ア ア ド レ ス を ifr_hwaddr を 用 い て 取 得 ・ 設 定 す る 。 ハ ー ド ウ ェ ア ア ド レ ス は sockaddr 構 造 体 に 設 定 さ れ る 。 sa_family に は ARPHRD_* デ バ イ ス タ イ プ が 入 り 、 sa_data に は バ イ ト 0 か ら 始 ま る L2 ハ ー ド ウ ェ ア ア ド レ ス が 入 る 。 ハ ー ド ウ ェ ア ア ド レ ス の 設 定 は 特 権 が 必 要 な 操 作 で あ る 。

SIOCSIFHWBROADCAST

デ バ イ ス の ハ ー ド ウ ェ ア ブ ロ ー ド キ ャ ス ト ア ド レ ス を ifr_hwaddr の 値 に 設 定 す る 。 こ の 操 作 に は 特 権 が 必 要 で あ る 。

SIOCGIFMAP , SIOCSIFMAP

イ ン タ ー フ ェ ー ス の ハ ー ド ウ ェ ア の パ ラ メ ー タ ー を ifr_map を 用 い て 取 得 ・ 設 定 す る 。 パ ラ メ ー タ ー の 設 定 は 特 権 が 必 要 な 操 作 で あ る 。

struct ifmap {
unsigned long mem_start;
unsigned long mem_end;
unsigned short base_addr;
unsigned char irq;
unsigned char dma;
unsigned char port;
};

ifmap 構 造 体 の 解 釈 は デ バ イ ス ド ラ イ バ と ア ー キ テ ク チ ャ ー に 依 存 す る 。

SIOCADDMULTI , SIOCDELMULTI

デ バ イ ス の リ ン ク 層 の マ ル チ キ ャ ス ト フ ィ ル タ ー か ら 、 ifr_hwaddr の ア ド レ ス を 追 加 ・ 削 除 す る 。 こ れ ら の 操 作 に は 特 権 が 必 要 で あ る 。 別 の 方 法 が packet (7) で 解 説 さ れ て い る 。

SIOCGIFTXQLEN , SIOCSIFTXQLEN

デ バ イ ス の 送 信 キ ュ ー の 長 さ を ifr_qlen に 取 得 ・ 設 定 す る 。 送 信 キ ュ ー の 長 さ の 設 定 に は 特 権 が 必 要 で あ る 。

SIOCSIFNAME

ifr_name で 指 定 し た イ ン タ ー フ ェ ー ス の 名 前 を ifr_newname に 変 更 す る 。 こ の 操 作 に は 特 権 が 必 要 で あ る 。 イ ン タ ー フ ェ ー ス が up し て い な い 時 に の み 使 用 で き る 。

SIOCGIFCONF

イ ン タ ー フ ェ ー ス の (ネ ッ ト ワ ー ク 層 の ) ア ド レ ス の リ ス ト を 返 す 。 現 在 の と こ ろ 、 互 換 性 の た め 返 さ れ る の は AF_INET (IPv4) 系 の ア ド レ ス だ け で あ る 。 他 の 操 作 と 違 い 、 こ の ioctl で は ifconf 構 造 体 を 渡 す 。

struct ifconf {
int ifc_len; /* バ ッ フ ァ ー サ イ ズ */
union {
char *ifc_buf; /* バ ッ フ ァ ー ア ド レ ス */
struct ifreq *ifc_req; /* 構 造 体 の 配 列 */
};
};

ifc_req が NULL の 場 合 、 SIOCGIFCONF は す べ て の 取 得 で き る ア ド レ ス を 受 け 取 る の に 必 要 な バ ッ フ ァ ー サ イ ズ (バ イ ト 数 ) を ifc_len に 格 納 し て 返 す 。 そ れ 以 外 の 場 合 は 、 ifc_req に は ifreq 構 造 体 の 配 列 へ の ポ イ ン タ ー を 渡 す 。 こ の 構 造 体 の 配 列 に は 現 在 ア ク テ ィ ブ な L3 イ ン タ ー フ ェ ー ス ア ド レ ス が す べ て 格 納 さ れ る 。 ifc_len は バ イ ト 単 位 の 配 列 の サ イ ズ を 渡 す 。 ifreq 構 造 体 内 で は 、 ifr_name に イ ン タ ー フ ェ ー ス 名 が 、 ifr_addr に そ の ア ド レ ス が 入 る 。 実 際 に 格 納 さ れ た バ イ ト 数 は ifc_len で 返 さ れ る 。

ifc_len で 指 定 さ れ た サ イ ズ が す べ て の ア ド レ ス を 格 納 す る の に 不 十 分 な 場 合 、 カ ー ネ ル は 超 過 分 を ス キ ッ プ し 、 成 功 を 返 す 。 こ の 状 況 に な っ た 場 合 、 そ れ を 検 出 す る 信 頼 で き る 方 法 は な い 。 し た が っ て 、 前 も っ て ifc_req を NULL に 設 定 し て SIOCGIFCONF を 呼 び 出 し て 必 要 な バ ッ フ ァ ー サ イ ズ を 決 定 す る か 、 返 さ れ た ifc_len と 元 の 値 の 差 分 が sizeof(struct ifreq) よ り も 小 さ い 場 合 は 必 ず バ ッ フ ァ ー を 大 き く し て 再 度 呼 び 出 す か 、 の い ず れ か を 行 う こ と が 推 奨 さ れ る 。

ifconf か ifreq 構 造 体 へ の ア ク セ ス で エ ラ ー が 置 こ っ た 場 合 に は EFAULT が 返 さ れ る 。

ほ と ん ど の プ ロ ト コ ル に は 、 専 用 の イ ン タ ー フ ェ ー ス オ プ シ ョ ン を 設 定 す る た め の 独 自 の ioctl が 存 在 す る 。 説 明 は 各 プ ロ ト コ ル の man ペ ー ジ を 見 よ 。 IP ア ド レ ス の 設 定 に 関 し て は ip (7) を 参 照 。

さ ら に 、 デ バ イ ス に よ っ て は プ ラ イ ベ ー ト な ioctl が あ る 。 こ れ ら は こ こ で は 説 明 し な い 。

注 意

SIOCGIFCONF and the other ioctls that accept or return only AF_INET socket addresses are IP-specific and perhaps should rather be documented in ip (7).

ア ド レ ス が な か っ た り 、 IFF_RUNNING フ ラ グ が セ ッ ト さ れ て い な い イ ン タ ー フ ェ ー ス の 名 前 は /proc/net/dev で 知 る こ と が で き る 。

ロ ー カ ル IPV6 IP ア ド レ ス は /proc/net か rtnetlink (7) で 知 る こ と が で き る 。

バ グ

glibc 2.1 で は <net/if.h> に ifr_newname マ ク ロ が な い 。 と り あ え ず の 対 応 策 と し て 、 以 下 の コ ー ド を 追 加 し て お く こ と 。

#ifndef ifr_newname
#define ifr_newname ifr_ifru.ifru_slave
#endif

関 連 項 目

proc (5), capabilities (7), ip (7), rtnetlink (7)

こ の 文 書 に つ い て

こ の man ペ ー ジ は Linux man-pages プ ロ ジ ェ ク ト の リ リ ー ス 5.10 の 一 部 で あ る 。 プ ロ ジ ェ ク ト の 説 明 と バ グ 報 告 に 関 す る 情 報 は https://www.kernel.org/doc/man-pages/ に 書 か れ て い る 。