Provided by: manpages-ja_0.5.0.0.20221215+dfsg-1_all bug

名前

       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 には以下の値のビット
              マスクが入る。

                                         デバイスフラグ
              IFF_UP            インターフェースは動作中。
              IFF_BROADCAST     有効なブロードキャストアドレスがセットされている。
              IFF_DEBUG         内部のデバッグフラグ。
              IFF_LOOPBACK      インターフェースはループバックである。
              IFF_POINTOPOINT   インターフェースは point-to-point リンクである。
              IFF_RUNNING       リソースが割り当て済み。
              IFF_NOARP         arp プロトコルがない。 L2 宛先アドレスが設定されて
                                いない。

              IFF_PROMISC       インターフェースは promiscuous モードである。
              IFF_NOTRAILERS    trailer の利用を避ける。
              IFF_ALLMULTI      全てのマルチキャストパケットを受信する。
              IFF_MASTER        負荷分散グループのマスターである。
              IFF_SLAVE         負荷分散グループのスレーブである。
              IFF_MULTICAST     マルチキャストをサポートしている。
              IFF_PORTSEL       ifmap によってメディアタイプを選択できる。
              IFF_AUTOMEDIA     自動メディア選択が有効になっている。
              IFF_DYNAMIC       このインターフェースが閉じると、アドレスは失われ
                                る。
              IFF_LOWER_UP      ドライバからの L1 アップの通知 (Linux 2.6.17 以降)
              IFF_DORMANT       ドライバからの休止状態の通知 (Linux 2.6.17 以降)
              IFF_ECHO          送られたパケットをエコーする (Linux 2.6.25 以降)

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

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

                                             プライベートフラグ
              IFF_802_1Q_VLAN      インターフェースは 802.1Q VLAN デバイスである。
              IFF_EBRIDGE          インターフェースは Ethernet ブリッジデバイスである。
              IFF_SLAVE_INACTIVE   インターフェースは非アクティブな bonding のスレーブである。
              IFF_MASTER_8023AD    インターフェースは 802.3ad bonding のマスターである。
              IFF_MASTER_ALB       インターフェースは balanced-alb bonding のマスターである。
              IFF_BONDING          インターフェースは bonding のマスターかスレーブである。
              IFF_SLAVE_NEEDARP    インターフェースは検証に APR が必要である。
              IFF_ISATAP           インターフェースは RFC4214 ISATAP インターフェースである。

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

       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)  よりも小さい場合は必ずバッファーを大きくして再度呼び出すか、
              のいずれかを行うことが推奨される。

              ifconfifreq 構造体へのアクセスでエラーが置こった場合には 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/netrtnetlink(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/ に書かれている。