1c398230bSWarner Losh /*- 2df8bae1dSRodney W. Grimes * Copyright (c) 1982, 1986, 1989, 1993 3df8bae1dSRodney W. Grimes * The Regents of the University of California. All rights reserved. 4df8bae1dSRodney W. Grimes * 5df8bae1dSRodney W. Grimes * Redistribution and use in source and binary forms, with or without 6df8bae1dSRodney W. Grimes * modification, are permitted provided that the following conditions 7df8bae1dSRodney W. Grimes * are met: 8df8bae1dSRodney W. Grimes * 1. Redistributions of source code must retain the above copyright 9df8bae1dSRodney W. Grimes * notice, this list of conditions and the following disclaimer. 10df8bae1dSRodney W. Grimes * 2. Redistributions in binary form must reproduce the above copyright 11df8bae1dSRodney W. Grimes * notice, this list of conditions and the following disclaimer in the 12df8bae1dSRodney W. Grimes * documentation and/or other materials provided with the distribution. 13df8bae1dSRodney W. Grimes * 4. Neither the name of the University nor the names of its contributors 14df8bae1dSRodney W. Grimes * may be used to endorse or promote products derived from this software 15df8bae1dSRodney W. Grimes * without specific prior written permission. 16df8bae1dSRodney W. Grimes * 17df8bae1dSRodney W. Grimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 18df8bae1dSRodney W. Grimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19df8bae1dSRodney W. Grimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20df8bae1dSRodney W. Grimes * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21df8bae1dSRodney W. Grimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22df8bae1dSRodney W. Grimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23df8bae1dSRodney W. Grimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24df8bae1dSRodney W. Grimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25df8bae1dSRodney W. Grimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26df8bae1dSRodney W. Grimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27df8bae1dSRodney W. Grimes * SUCH DAMAGE. 28df8bae1dSRodney W. Grimes * 29df8bae1dSRodney W. Grimes * @(#)if.h 8.1 (Berkeley) 6/10/93 30c3aac50fSPeter Wemm * $FreeBSD$ 31df8bae1dSRodney W. Grimes */ 32df8bae1dSRodney W. Grimes 33cea1da3bSPaul Richards #ifndef _NET_IF_H_ 34cea1da3bSPaul Richards #define _NET_IF_H_ 35cea1da3bSPaul Richards 36f2ba8326SMike Barcroft #include <sys/cdefs.h> 37f2ba8326SMike Barcroft 38f2ba8326SMike Barcroft #if __BSD_VISIBLE 39df8bae1dSRodney W. Grimes /* 4009410d0fSPeter Wemm * <net/if.h> does not depend on <sys/time.h> on most other systems. This 412fa72ea7SJeroen Ruigrok van der Werven * helps userland compatibility. (struct timeval ifi_lastchange) 42cf05e311SEd Schouten * The same holds for <sys/socket.h>. (struct sockaddr ifru_addr) 4309410d0fSPeter Wemm */ 44664a31e4SPeter Wemm #ifndef _KERNEL 4509410d0fSPeter Wemm #include <sys/time.h> 46cf05e311SEd Schouten #include <sys/socket.h> 4709410d0fSPeter Wemm #endif 48f2ba8326SMike Barcroft #endif 4930aad87dSBrooks Davis 5030aad87dSBrooks Davis /* 5130aad87dSBrooks Davis * Length of interface external name, including terminating '\0'. 5230aad87dSBrooks Davis * Note: this is the same size as a generic device's external name. 5330aad87dSBrooks Davis */ 54f2ba8326SMike Barcroft #define IF_NAMESIZE 16 55f2ba8326SMike Barcroft #if __BSD_VISIBLE 56f2ba8326SMike Barcroft #define IFNAMSIZ IF_NAMESIZE 579bf40edeSBrooks Davis #define IF_MAXUNIT 0x7fff /* historical value */ 58f2ba8326SMike Barcroft #endif 59f2ba8326SMike Barcroft #if __BSD_VISIBLE 60f2ba8326SMike Barcroft 6130aad87dSBrooks Davis /* 6230aad87dSBrooks Davis * Structure used to query names of interface cloners. 6330aad87dSBrooks Davis */ 6430aad87dSBrooks Davis 6530aad87dSBrooks Davis struct if_clonereq { 6630aad87dSBrooks Davis int ifcr_total; /* total cloners (out) */ 6730aad87dSBrooks Davis int ifcr_count; /* room for this many in user buffer */ 6830aad87dSBrooks Davis char *ifcr_buffer; /* buffer for cloner names */ 6930aad87dSBrooks Davis }; 7030aad87dSBrooks Davis 7109410d0fSPeter Wemm /* 72a73356a1SBill Fenner * Structure describing information about an interface 73a73356a1SBill Fenner * which may be of interest to management entities. 74a73356a1SBill Fenner */ 75df8bae1dSRodney W. Grimes struct if_data { 76df8bae1dSRodney W. Grimes /* generic interface information */ 77b245f96cSGleb Smirnoff uint8_t ifi_type; /* ethernet, tokenring, etc */ 78b245f96cSGleb Smirnoff uint8_t ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */ 79b245f96cSGleb Smirnoff uint8_t ifi_addrlen; /* media address length */ 80b245f96cSGleb Smirnoff uint8_t ifi_hdrlen; /* media header length */ 81b245f96cSGleb Smirnoff uint8_t ifi_link_state; /* current link state */ 82b245f96cSGleb Smirnoff uint8_t ifi_vhid; /* carp vhid */ 83b245f96cSGleb Smirnoff uint16_t ifi_datalen; /* length of this data struct */ 84b245f96cSGleb Smirnoff uint32_t ifi_mtu; /* maximum transmission unit */ 85b245f96cSGleb Smirnoff uint32_t ifi_metric; /* routing metric (external only) */ 86b245f96cSGleb Smirnoff uint64_t ifi_baudrate; /* linespeed */ 87df8bae1dSRodney W. Grimes /* volatile statistics */ 88b245f96cSGleb Smirnoff uint64_t ifi_ipackets; /* packets received on interface */ 89b245f96cSGleb Smirnoff uint64_t ifi_ierrors; /* input errors on interface */ 90b245f96cSGleb Smirnoff uint64_t ifi_opackets; /* packets sent on interface */ 91b245f96cSGleb Smirnoff uint64_t ifi_oerrors; /* output errors on interface */ 92b245f96cSGleb Smirnoff uint64_t ifi_collisions; /* collisions on csma interfaces */ 93b245f96cSGleb Smirnoff uint64_t ifi_ibytes; /* total number of octets received */ 94b245f96cSGleb Smirnoff uint64_t ifi_obytes; /* total number of octets sent */ 95b245f96cSGleb Smirnoff uint64_t ifi_imcasts; /* packets received via multicast */ 96b245f96cSGleb Smirnoff uint64_t ifi_omcasts; /* packets sent via multicast */ 97b245f96cSGleb Smirnoff uint64_t ifi_iqdrops; /* dropped on input */ 98b245f96cSGleb Smirnoff uint64_t ifi_oqdrops; /* dropped on output */ 99b245f96cSGleb Smirnoff uint64_t ifi_noproto; /* destined for unsupported protocol */ 1001b4381afSAndre Oppermann uint64_t ifi_hwassist; /* HW offload capabilities, see IFCAP */ 101b245f96cSGleb Smirnoff 102b245f96cSGleb Smirnoff /* Unions are here to make sizes MI. */ 103b245f96cSGleb Smirnoff union { /* uptime at attach or stat reset */ 104b245f96cSGleb Smirnoff time_t tt; 105b245f96cSGleb Smirnoff uint64_t ph; 106b245f96cSGleb Smirnoff } __ifi_epoch; 107b245f96cSGleb Smirnoff #define ifi_epoch __ifi_epoch.tt 108b245f96cSGleb Smirnoff union { /* time of last administrative change */ 109b245f96cSGleb Smirnoff struct timeval tv; 110b245f96cSGleb Smirnoff struct { 111b245f96cSGleb Smirnoff uint64_t ph1; 112b245f96cSGleb Smirnoff uint64_t ph2; 113b245f96cSGleb Smirnoff } ph; 114b245f96cSGleb Smirnoff } __ifi_lastchange; 115b245f96cSGleb Smirnoff #define ifi_lastchange __ifi_lastchange.tv 1166f64074eSJoerg Wunsch }; 1176f64074eSJoerg Wunsch 118fc574570SRobert Watson /*- 119292ee7beSRobert Watson * Interface flags are of two types: network stack owned flags, and driver 120292ee7beSRobert Watson * owned flags. Historically, these values were stored in the same ifnet 121292ee7beSRobert Watson * flags field, but with the advent of fine-grained locking, they have been 122292ee7beSRobert Watson * broken out such that the network stack is responsible for synchronizing 123292ee7beSRobert Watson * the stack-owned fields, and the device driver the device-owned fields. 124292ee7beSRobert Watson * Both halves can perform lockless reads of the other half's field, subject 125292ee7beSRobert Watson * to accepting the involved races. 126292ee7beSRobert Watson * 127292ee7beSRobert Watson * Both sets of flags come from the same number space, and should not be 128292ee7beSRobert Watson * permitted to conflict, as they are exposed to user space via a single 129292ee7beSRobert Watson * field. 130292ee7beSRobert Watson * 131fc574570SRobert Watson * The following symbols identify read and write requirements for fields: 132fc574570SRobert Watson * 133fc574570SRobert Watson * (i) if_flags field set by device driver before attach, read-only there 134fc574570SRobert Watson * after. 135fc574570SRobert Watson * (n) if_flags field written only by the network stack, read by either the 136fc574570SRobert Watson * stack or driver. 137fc574570SRobert Watson * (d) if_drv_flags field written only by the device driver, read by either 138fc574570SRobert Watson * the stack or driver. 139292ee7beSRobert Watson */ 140fc574570SRobert Watson #define IFF_UP 0x1 /* (n) interface is up */ 141fc574570SRobert Watson #define IFF_BROADCAST 0x2 /* (i) broadcast address valid */ 142fc574570SRobert Watson #define IFF_DEBUG 0x4 /* (n) turn on debugging */ 143fc574570SRobert Watson #define IFF_LOOPBACK 0x8 /* (i) is a loopback net */ 144fc574570SRobert Watson #define IFF_POINTOPOINT 0x10 /* (i) is a point-to-point link */ 145af50ea38SGleb Smirnoff /* 0x20 was IFF_SMART */ 146fc574570SRobert Watson #define IFF_DRV_RUNNING 0x40 /* (d) resources allocated */ 147fc574570SRobert Watson #define IFF_NOARP 0x80 /* (n) no address resolution protocol */ 148fc574570SRobert Watson #define IFF_PROMISC 0x100 /* (n) receive all packets */ 149fc574570SRobert Watson #define IFF_ALLMULTI 0x200 /* (n) receive all multicast packets */ 150fc574570SRobert Watson #define IFF_DRV_OACTIVE 0x400 /* (d) tx hardware queue is full */ 151fc574570SRobert Watson #define IFF_SIMPLEX 0x800 /* (i) can't hear own transmissions */ 152df8bae1dSRodney W. Grimes #define IFF_LINK0 0x1000 /* per link layer defined bit */ 153df8bae1dSRodney W. Grimes #define IFF_LINK1 0x2000 /* per link layer defined bit */ 154df8bae1dSRodney W. Grimes #define IFF_LINK2 0x4000 /* per link layer defined bit */ 15537be1da8SGarrett Wollman #define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */ 156fc574570SRobert Watson #define IFF_MULTICAST 0x8000 /* (i) supports multicast */ 1576e3cb000SWeongyo Jeong #define IFF_CANTCONFIG 0x10000 /* (i) unconfigurable using ioctl(2) */ 158fc574570SRobert Watson #define IFF_PPROMISC 0x20000 /* (n) user-requested promisc mode */ 159fc574570SRobert Watson #define IFF_MONITOR 0x40000 /* (n) user-requested monitor mode */ 160fc574570SRobert Watson #define IFF_STATICARP 0x80000 /* (n) static ARP */ 161242a8e72SRobert Watson #define IFF_DYING 0x200000 /* (n) interface is winding down */ 1625428776eSJohn Baldwin #define IFF_RENAMING 0x400000 /* (n) interface is being renamed */ 163292ee7beSRobert Watson /* 164292ee7beSRobert Watson * Old names for driver flags so that user space tools can continue to use 165fc574570SRobert Watson * the old (portable) names. 166292ee7beSRobert Watson */ 167292ee7beSRobert Watson #ifndef _KERNEL 168292ee7beSRobert Watson #define IFF_RUNNING IFF_DRV_RUNNING 169292ee7beSRobert Watson #define IFF_OACTIVE IFF_DRV_OACTIVE 170292ee7beSRobert Watson #endif 171292ee7beSRobert Watson 172df8bae1dSRodney W. Grimes /* flags set internally only: */ 173df8bae1dSRodney W. Grimes #define IFF_CANTCHANGE \ 174292ee7beSRobert Watson (IFF_BROADCAST|IFF_POINTOPOINT|IFF_DRV_RUNNING|IFF_DRV_OACTIVE|\ 175af50ea38SGleb Smirnoff IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_PROMISC|\ 176c5649739SWeongyo Jeong IFF_DYING|IFF_CANTCONFIG) 177df8bae1dSRodney W. Grimes 178bb68f0afSSam Leffler /* 179127d7b2dSAndre Oppermann * Values for if_link_state. 180127d7b2dSAndre Oppermann */ 181127d7b2dSAndre Oppermann #define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */ 182127d7b2dSAndre Oppermann #define LINK_STATE_DOWN 1 /* link is down */ 183127d7b2dSAndre Oppermann #define LINK_STATE_UP 2 /* link is up */ 184127d7b2dSAndre Oppermann 185127d7b2dSAndre Oppermann /* 186bb68f0afSSam Leffler * Some convenience macros used for setting ifi_baudrate. 187bb68f0afSSam Leffler * XXX 1000 vs. 1024? --thorpej@netbsd.org 188bb68f0afSSam Leffler */ 189608ae712SMaksim Yevmenkin #define IF_Kbps(x) ((uintmax_t)(x) * 1000) /* kilobits/sec. */ 190bb68f0afSSam Leffler #define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */ 191bb68f0afSSam Leffler #define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */ 192bb68f0afSSam Leffler 19360d4ab7aSAndre Oppermann /* 19460d4ab7aSAndre Oppermann * Capabilities that interfaces can advertise. 19560d4ab7aSAndre Oppermann * 19660d4ab7aSAndre Oppermann * struct ifnet.if_capabilities 19760d4ab7aSAndre Oppermann * contains the optional features & capabilities a particular interface 19860d4ab7aSAndre Oppermann * supports (not only the driver but also the detected hw revision). 19960d4ab7aSAndre Oppermann * Capabilities are defined by IFCAP_* below. 200d562befcSYaroslav Tykhiy * struct ifnet.if_capenable 20160d4ab7aSAndre Oppermann * contains the enabled (either by default or through ifconfig) optional 20260d4ab7aSAndre Oppermann * features & capabilities on this interface. 20360d4ab7aSAndre Oppermann * Capabilities are defined by IFCAP_* below. 20460d4ab7aSAndre Oppermann * struct if_data.ifi_hwassist in mbuf CSUM_ flag form, controlled by above 20560d4ab7aSAndre Oppermann * contains the enabled optional feature & capabilites that can be used 20660d4ab7aSAndre Oppermann * individually per packet and are specified in the mbuf pkthdr.csum_flags 20760d4ab7aSAndre Oppermann * field. IFCAP_* and CSUM_* do not match one to one and CSUM_* may be 208d562befcSYaroslav Tykhiy * more detailed or differenciated than IFCAP_*. 20960d4ab7aSAndre Oppermann * Hwassist features are defined CSUM_* in sys/mbuf.h 210c9d658e9SLuigi Rizzo * 211c9d658e9SLuigi Rizzo * Capabilities that cannot be arbitrarily changed with ifconfig/ioctl 212c9d658e9SLuigi Rizzo * are listed in IFCAP_CANTCHANGE, similar to IFF_CANTCHANGE. 213c9d658e9SLuigi Rizzo * This is not strictly necessary because the common code never 214c9d658e9SLuigi Rizzo * changes capabilities, and it is left to the individual driver 215c9d658e9SLuigi Rizzo * to do the right thing. However, having the filter here 216c9d658e9SLuigi Rizzo * avoids replication of the same code in all individual drivers. 21760d4ab7aSAndre Oppermann */ 21822893351SJack F Vogel #define IFCAP_RXCSUM 0x00001 /* can offload checksum on RX */ 21922893351SJack F Vogel #define IFCAP_TXCSUM 0x00002 /* can offload checksum on TX */ 22022893351SJack F Vogel #define IFCAP_NETCONS 0x00004 /* can be a network console */ 22122893351SJack F Vogel #define IFCAP_VLAN_MTU 0x00008 /* VLAN-compatible MTU */ 22222893351SJack F Vogel #define IFCAP_VLAN_HWTAGGING 0x00010 /* hardware VLAN tag support */ 22322893351SJack F Vogel #define IFCAP_JUMBO_MTU 0x00020 /* 9000 byte MTU supported */ 22422893351SJack F Vogel #define IFCAP_POLLING 0x00040 /* driver supports polling */ 22522893351SJack F Vogel #define IFCAP_VLAN_HWCSUM 0x00080 /* can do IFCAP_HWCSUM on VLANs */ 22622893351SJack F Vogel #define IFCAP_TSO4 0x00100 /* can do TCP Segmentation Offload */ 22722893351SJack F Vogel #define IFCAP_TSO6 0x00200 /* can do TCP6 Segmentation Offload */ 22822893351SJack F Vogel #define IFCAP_LRO 0x00400 /* can do Large Receive Offload */ 22922893351SJack F Vogel #define IFCAP_WOL_UCAST 0x00800 /* wake on any unicast frame */ 23022893351SJack F Vogel #define IFCAP_WOL_MCAST 0x01000 /* wake on any multicast frame */ 23122893351SJack F Vogel #define IFCAP_WOL_MAGIC 0x02000 /* wake on any Magic Packet */ 23222893351SJack F Vogel #define IFCAP_TOE4 0x04000 /* interface can offload TCP */ 23322893351SJack F Vogel #define IFCAP_TOE6 0x08000 /* interface can offload TCP6 */ 23422893351SJack F Vogel #define IFCAP_VLAN_HWFILTER 0x10000 /* interface hw can filter vlan tag */ 2351abcdbd1SAttilio Rao #define IFCAP_POLLING_NOCOUNT 0x20000 /* polling ticks cannot be fragmented */ 2369b76d9cbSPyun YongHyeon #define IFCAP_VLAN_HWTSO 0x40000 /* can do IFCAP_TSO on VLANs */ 2376b533b5dSQing Li #define IFCAP_LINKSTATE 0x80000 /* the runtime link state is dynamic */ 238c9d658e9SLuigi Rizzo #define IFCAP_NETMAP 0x100000 /* netmap mode supported/enabled */ 239356ab07eSBjoern A. Zeeb #define IFCAP_RXCSUM_IPV6 0x200000 /* can offload checksum on IPv6 RX */ 240356ab07eSBjoern A. Zeeb #define IFCAP_TXCSUM_IPV6 0x400000 /* can offload checksum on IPv6 TX */ 2414cdc1f54SGleb Smirnoff #define IFCAP_HWSTATS 0x800000 /* manages counters internally */ 242356ab07eSBjoern A. Zeeb 243356ab07eSBjoern A. Zeeb #define IFCAP_HWCSUM_IPV6 (IFCAP_RXCSUM_IPV6 | IFCAP_TXCSUM_IPV6) 244f7d86692SJonathan Lemon 245f7d86692SJonathan Lemon #define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM) 246233dcce1SAndre Oppermann #define IFCAP_TSO (IFCAP_TSO4 | IFCAP_TSO6) 247de0abf19SSam Leffler #define IFCAP_WOL (IFCAP_WOL_UCAST | IFCAP_WOL_MCAST | IFCAP_WOL_MAGIC) 2484c908c35SKip Macy #define IFCAP_TOE (IFCAP_TOE4 | IFCAP_TOE6) 249016da741SJonathan Lemon 250c9d658e9SLuigi Rizzo #define IFCAP_CANTCHANGE (IFCAP_NETMAP) 251c9d658e9SLuigi Rizzo 252df8bae1dSRodney W. Grimes #define IFQ_MAXLEN 50 253df8bae1dSRodney W. Grimes #define IFNET_SLOWHZ 1 /* granularity is 1 second */ 254df8bae1dSRodney W. Grimes 255df8bae1dSRodney W. Grimes /* 256df8bae1dSRodney W. Grimes * Message format for use in obtaining information about interfaces 257df8bae1dSRodney W. Grimes * from getkerninfo and the routing socket 2586d076ae8SBjoern A. Zeeb * For the new, extensible interface see struct if_msghdrl below. 259df8bae1dSRodney W. Grimes */ 260df8bae1dSRodney W. Grimes struct if_msghdr { 261df8bae1dSRodney W. Grimes u_short ifm_msglen; /* to skip over non-understood messages */ 2622fa72ea7SJeroen Ruigrok van der Werven u_char ifm_version; /* future binary compatibility */ 263df8bae1dSRodney W. Grimes u_char ifm_type; /* message type */ 264df8bae1dSRodney W. Grimes int ifm_addrs; /* like rtm_addrs */ 265df8bae1dSRodney W. Grimes int ifm_flags; /* value of if_flags */ 266df8bae1dSRodney W. Grimes u_short ifm_index; /* index for associated ifp */ 267df8bae1dSRodney W. Grimes struct if_data ifm_data;/* statistics and other data about if */ 268df8bae1dSRodney W. Grimes }; 269df8bae1dSRodney W. Grimes 270df8bae1dSRodney W. Grimes /* 2716d076ae8SBjoern A. Zeeb * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL. It is 2726d076ae8SBjoern A. Zeeb * extensible after ifm_data_off or within ifm_data. Both the if_msghdr and 2736d076ae8SBjoern A. Zeeb * if_data now have a member field detailing the struct length in addition to 2746d076ae8SBjoern A. Zeeb * the routing message length. Macros are provided to find the start of 2756d076ae8SBjoern A. Zeeb * ifm_data and the start of the socket address strucutres immediately following 2766d076ae8SBjoern A. Zeeb * struct if_msghdrl given a pointer to struct if_msghdrl. 2776d076ae8SBjoern A. Zeeb */ 2786d076ae8SBjoern A. Zeeb #define IF_MSGHDRL_IFM_DATA(_l) \ 2796d076ae8SBjoern A. Zeeb (struct if_data *)((char *)(_l) + (_l)->ifm_data_off) 2806d076ae8SBjoern A. Zeeb #define IF_MSGHDRL_RTA(_l) \ 2816d076ae8SBjoern A. Zeeb (void *)((uintptr_t)(_l) + (_l)->ifm_len) 2826d076ae8SBjoern A. Zeeb struct if_msghdrl { 2836d076ae8SBjoern A. Zeeb u_short ifm_msglen; /* to skip over non-understood messages */ 2846d076ae8SBjoern A. Zeeb u_char ifm_version; /* future binary compatibility */ 2856d076ae8SBjoern A. Zeeb u_char ifm_type; /* message type */ 2866d076ae8SBjoern A. Zeeb int ifm_addrs; /* like rtm_addrs */ 2876d076ae8SBjoern A. Zeeb int ifm_flags; /* value of if_flags */ 2886d076ae8SBjoern A. Zeeb u_short ifm_index; /* index for associated ifp */ 2896d076ae8SBjoern A. Zeeb u_short _ifm_spare1; /* spare space to grow if_index, see if_var.h */ 2906d076ae8SBjoern A. Zeeb u_short ifm_len; /* length of if_msghdrl incl. if_data */ 2916d076ae8SBjoern A. Zeeb u_short ifm_data_off; /* offset of if_data from beginning */ 2926d076ae8SBjoern A. Zeeb struct if_data ifm_data;/* statistics and other data about if */ 2936d076ae8SBjoern A. Zeeb }; 2946d076ae8SBjoern A. Zeeb 2956d076ae8SBjoern A. Zeeb /* 296df8bae1dSRodney W. Grimes * Message format for use in obtaining information about interface addresses 297df8bae1dSRodney W. Grimes * from getkerninfo and the routing socket 2986d076ae8SBjoern A. Zeeb * For the new, extensible interface see struct ifa_msghdrl below. 299df8bae1dSRodney W. Grimes */ 300df8bae1dSRodney W. Grimes struct ifa_msghdr { 301df8bae1dSRodney W. Grimes u_short ifam_msglen; /* to skip over non-understood messages */ 3022fa72ea7SJeroen Ruigrok van der Werven u_char ifam_version; /* future binary compatibility */ 303df8bae1dSRodney W. Grimes u_char ifam_type; /* message type */ 304df8bae1dSRodney W. Grimes int ifam_addrs; /* like rtm_addrs */ 305df8bae1dSRodney W. Grimes int ifam_flags; /* value of ifa_flags */ 306df8bae1dSRodney W. Grimes u_short ifam_index; /* index for associated ifp */ 3079753faf5SGleb Smirnoff int ifam_metric; /* value of ifa_ifp->if_metric */ 308df8bae1dSRodney W. Grimes }; 309df8bae1dSRodney W. Grimes 310df8bae1dSRodney W. Grimes /* 3116d076ae8SBjoern A. Zeeb * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL. It is 3126d076ae8SBjoern A. Zeeb * extensible after ifam_metric or within ifam_data. Both the ifa_msghdrl and 3136d076ae8SBjoern A. Zeeb * if_data now have a member field detailing the struct length in addition to 3146d076ae8SBjoern A. Zeeb * the routing message length. Macros are provided to find the start of 3156d076ae8SBjoern A. Zeeb * ifm_data and the start of the socket address strucutres immediately following 3166d076ae8SBjoern A. Zeeb * struct ifa_msghdrl given a pointer to struct ifa_msghdrl. 3176d076ae8SBjoern A. Zeeb */ 3186d076ae8SBjoern A. Zeeb #define IFA_MSGHDRL_IFAM_DATA(_l) \ 3196d076ae8SBjoern A. Zeeb (struct if_data *)((char *)(_l) + (_l)->ifam_data_off) 3206d076ae8SBjoern A. Zeeb #define IFA_MSGHDRL_RTA(_l) \ 3216d076ae8SBjoern A. Zeeb (void *)((uintptr_t)(_l) + (_l)->ifam_len) 3226d076ae8SBjoern A. Zeeb struct ifa_msghdrl { 3236d076ae8SBjoern A. Zeeb u_short ifam_msglen; /* to skip over non-understood messages */ 3246d076ae8SBjoern A. Zeeb u_char ifam_version; /* future binary compatibility */ 3256d076ae8SBjoern A. Zeeb u_char ifam_type; /* message type */ 3266d076ae8SBjoern A. Zeeb int ifam_addrs; /* like rtm_addrs */ 3276d076ae8SBjoern A. Zeeb int ifam_flags; /* value of ifa_flags */ 3286d076ae8SBjoern A. Zeeb u_short ifam_index; /* index for associated ifp */ 3296d076ae8SBjoern A. Zeeb u_short _ifam_spare1; /* spare space to grow if_index, see if_var.h */ 3306d076ae8SBjoern A. Zeeb u_short ifam_len; /* length of ifa_msghdrl incl. if_data */ 3316d076ae8SBjoern A. Zeeb u_short ifam_data_off; /* offset of if_data from beginning */ 3329753faf5SGleb Smirnoff int ifam_metric; /* value of ifa_ifp->if_metric */ 3336d076ae8SBjoern A. Zeeb struct if_data ifam_data;/* statistics and other data about if or 3346d076ae8SBjoern A. Zeeb * address */ 3356d076ae8SBjoern A. Zeeb }; 3366d076ae8SBjoern A. Zeeb 3376d076ae8SBjoern A. Zeeb /* 338477180fbSGarrett Wollman * Message format for use in obtaining information about multicast addresses 339477180fbSGarrett Wollman * from the routing socket 340477180fbSGarrett Wollman */ 341477180fbSGarrett Wollman struct ifma_msghdr { 342477180fbSGarrett Wollman u_short ifmam_msglen; /* to skip over non-understood messages */ 3432fa72ea7SJeroen Ruigrok van der Werven u_char ifmam_version; /* future binary compatibility */ 344477180fbSGarrett Wollman u_char ifmam_type; /* message type */ 345477180fbSGarrett Wollman int ifmam_addrs; /* like rtm_addrs */ 346477180fbSGarrett Wollman int ifmam_flags; /* value of ifa_flags */ 347477180fbSGarrett Wollman u_short ifmam_index; /* index for associated ifp */ 348477180fbSGarrett Wollman }; 349477180fbSGarrett Wollman 350477180fbSGarrett Wollman /* 3517b6edd04SRuslan Ermilov * Message format announcing the arrival or departure of a network interface. 3527b6edd04SRuslan Ermilov */ 3537b6edd04SRuslan Ermilov struct if_announcemsghdr { 3547b6edd04SRuslan Ermilov u_short ifan_msglen; /* to skip over non-understood messages */ 3557b6edd04SRuslan Ermilov u_char ifan_version; /* future binary compatibility */ 3567b6edd04SRuslan Ermilov u_char ifan_type; /* message type */ 3577b6edd04SRuslan Ermilov u_short ifan_index; /* index for associated ifp */ 3587b6edd04SRuslan Ermilov char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 3597b6edd04SRuslan Ermilov u_short ifan_what; /* what type of announcement */ 3607b6edd04SRuslan Ermilov }; 3617b6edd04SRuslan Ermilov 3627b6edd04SRuslan Ermilov #define IFAN_ARRIVAL 0 /* interface arrival */ 3637b6edd04SRuslan Ermilov #define IFAN_DEPARTURE 1 /* interface departure */ 3647b6edd04SRuslan Ermilov 3657b6edd04SRuslan Ermilov /* 366215940b3SXin LI * Buffer with length to be used in SIOCGIFDESCR/SIOCSIFDESCR requests 367215940b3SXin LI */ 368215940b3SXin LI struct ifreq_buffer { 369215940b3SXin LI size_t length; 370215940b3SXin LI void *buffer; 371215940b3SXin LI }; 372215940b3SXin LI 373215940b3SXin LI /* 374df8bae1dSRodney W. Grimes * Interface request structure used for socket 375df8bae1dSRodney W. Grimes * ioctl's. All interface ioctl's must have parameter 376df8bae1dSRodney W. Grimes * definitions which begin with ifr_name. The 377df8bae1dSRodney W. Grimes * remainder may be interface specific. 378df8bae1dSRodney W. Grimes */ 379df8bae1dSRodney W. Grimes struct ifreq { 380df8bae1dSRodney W. Grimes char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 381df8bae1dSRodney W. Grimes union { 382df8bae1dSRodney W. Grimes struct sockaddr ifru_addr; 383df8bae1dSRodney W. Grimes struct sockaddr ifru_dstaddr; 384df8bae1dSRodney W. Grimes struct sockaddr ifru_broadaddr; 385215940b3SXin LI struct ifreq_buffer ifru_buffer; 3864add131eSPoul-Henning Kamp short ifru_flags[2]; 387de593450SJonathan Lemon short ifru_index; 388679e1390SJamie Gritton int ifru_jid; 389df8bae1dSRodney W. Grimes int ifru_metric; 390a7028af7SDavid Greenman int ifru_mtu; 391074c4a4eSGarrett Wollman int ifru_phys; 392a912e453SPeter Wemm int ifru_media; 393df8bae1dSRodney W. Grimes caddr_t ifru_data; 394016da741SJonathan Lemon int ifru_cap[2]; 39535fd7bc0SBjoern A. Zeeb u_int ifru_fib; 396*2ccbbd06SMarcelo Araujo u_char ifru_vlan_pcp; 397df8bae1dSRodney W. Grimes } ifr_ifru; 398df8bae1dSRodney W. Grimes #define ifr_addr ifr_ifru.ifru_addr /* address */ 399df8bae1dSRodney W. Grimes #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 400df8bae1dSRodney W. Grimes #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 401215940b3SXin LI #define ifr_buffer ifr_ifru.ifru_buffer /* user supplied buffer with its length */ 40262f76486SMaxim Sobolev #define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */ 40362f76486SMaxim Sobolev #define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */ 404679e1390SJamie Gritton #define ifr_jid ifr_ifru.ifru_jid /* jail/vnet */ 405df8bae1dSRodney W. Grimes #define ifr_metric ifr_ifru.ifru_metric /* metric */ 406a7028af7SDavid Greenman #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 407511cdd16SDavid Greenman #define ifr_phys ifr_ifru.ifru_phys /* physical wire */ 408a912e453SPeter Wemm #define ifr_media ifr_ifru.ifru_media /* physical media */ 409df8bae1dSRodney W. Grimes #define ifr_data ifr_ifru.ifru_data /* for use by interface */ 410016da741SJonathan Lemon #define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */ 411016da741SJonathan Lemon #define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */ 412de593450SJonathan Lemon #define ifr_index ifr_ifru.ifru_index /* interface index */ 41335fd7bc0SBjoern A. Zeeb #define ifr_fib ifr_ifru.ifru_fib /* interface fib */ 414*2ccbbd06SMarcelo Araujo #define ifr_vlan_pcp ifr_ifru.ifru_vlan_pcp /* VLAN priority */ 415df8bae1dSRodney W. Grimes }; 416df8bae1dSRodney W. Grimes 417906f09bcSGarrett Wollman #define _SIZEOF_ADDR_IFREQ(ifr) \ 418906f09bcSGarrett Wollman ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \ 419906f09bcSGarrett Wollman (sizeof(struct ifreq) - sizeof(struct sockaddr) + \ 420906f09bcSGarrett Wollman (ifr).ifr_addr.sa_len) : sizeof(struct ifreq)) 421906f09bcSGarrett Wollman 422df8bae1dSRodney W. Grimes struct ifaliasreq { 423df8bae1dSRodney W. Grimes char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 424df8bae1dSRodney W. Grimes struct sockaddr ifra_addr; 425df8bae1dSRodney W. Grimes struct sockaddr ifra_broadaddr; 426df8bae1dSRodney W. Grimes struct sockaddr ifra_mask; 42708b68b0eSGleb Smirnoff int ifra_vhid; 428df8bae1dSRodney W. Grimes }; 429df8bae1dSRodney W. Grimes 43077b89ad8SGleb Smirnoff /* 9.x compat */ 43177b89ad8SGleb Smirnoff struct oifaliasreq { 43277b89ad8SGleb Smirnoff char ifra_name[IFNAMSIZ]; 43377b89ad8SGleb Smirnoff struct sockaddr ifra_addr; 43477b89ad8SGleb Smirnoff struct sockaddr ifra_broadaddr; 43577b89ad8SGleb Smirnoff struct sockaddr ifra_mask; 43677b89ad8SGleb Smirnoff }; 43777b89ad8SGleb Smirnoff 438a912e453SPeter Wemm struct ifmediareq { 439a912e453SPeter Wemm char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 440a912e453SPeter Wemm int ifm_current; /* current media options */ 441a912e453SPeter Wemm int ifm_mask; /* don't care mask */ 442a912e453SPeter Wemm int ifm_status; /* media status */ 443a912e453SPeter Wemm int ifm_active; /* active options */ 444a912e453SPeter Wemm int ifm_count; /* # entries in ifm_ulist array */ 445a912e453SPeter Wemm int *ifm_ulist; /* media words */ 446a912e453SPeter Wemm }; 447413dd0baSPoul-Henning Kamp 4488f867517SAndrew Thompson struct ifdrv { 4498f867517SAndrew Thompson char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 4508f867517SAndrew Thompson unsigned long ifd_cmd; 4518f867517SAndrew Thompson size_t ifd_len; 4528f867517SAndrew Thompson void *ifd_data; 4538f867517SAndrew Thompson }; 4548f867517SAndrew Thompson 455413dd0baSPoul-Henning Kamp /* 456413dd0baSPoul-Henning Kamp * Structure used to retrieve aux status data from interfaces. 457712020a1SBruce Evans * Kernel suppliers to this interface should respect the formatting 458413dd0baSPoul-Henning Kamp * needed by ifconfig(8): each line starts with a TAB and ends with 459712020a1SBruce Evans * a newline. The canonical example to copy and paste is in if_tun.c. 460413dd0baSPoul-Henning Kamp */ 461413dd0baSPoul-Henning Kamp 462413dd0baSPoul-Henning Kamp #define IFSTATMAX 800 /* 10 lines of text */ 463413dd0baSPoul-Henning Kamp struct ifstat { 464413dd0baSPoul-Henning Kamp char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 465413dd0baSPoul-Henning Kamp char ascii[IFSTATMAX + 1]; 466413dd0baSPoul-Henning Kamp }; 467413dd0baSPoul-Henning Kamp 468df8bae1dSRodney W. Grimes /* 469df8bae1dSRodney W. Grimes * Structure used in SIOCGIFCONF request. 470df8bae1dSRodney W. Grimes * Used to retrieve interface configuration 471df8bae1dSRodney W. Grimes * for machine (useful for programs which 472df8bae1dSRodney W. Grimes * must know all networks accessible). 473df8bae1dSRodney W. Grimes */ 474df8bae1dSRodney W. Grimes struct ifconf { 475df8bae1dSRodney W. Grimes int ifc_len; /* size of associated buffer */ 476df8bae1dSRodney W. Grimes union { 477df8bae1dSRodney W. Grimes caddr_t ifcu_buf; 478df8bae1dSRodney W. Grimes struct ifreq *ifcu_req; 479df8bae1dSRodney W. Grimes } ifc_ifcu; 480df8bae1dSRodney W. Grimes #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 481df8bae1dSRodney W. Grimes #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 482df8bae1dSRodney W. Grimes }; 483df8bae1dSRodney W. Grimes 48476429de4SYoshinobu Inoue /* 4850dad3f0eSMax Laier * interface groups 4860dad3f0eSMax Laier */ 4870dad3f0eSMax Laier 4880dad3f0eSMax Laier #define IFG_ALL "all" /* group contains all interfaces */ 4890dad3f0eSMax Laier /* XXX: will we implement this? */ 4900dad3f0eSMax Laier #define IFG_EGRESS "egress" /* if(s) default route(s) point to */ 4910dad3f0eSMax Laier 4920dad3f0eSMax Laier struct ifg_req { 4930dad3f0eSMax Laier union { 4940dad3f0eSMax Laier char ifgrqu_group[IFNAMSIZ]; 4950dad3f0eSMax Laier char ifgrqu_member[IFNAMSIZ]; 4960dad3f0eSMax Laier } ifgrq_ifgrqu; 4970dad3f0eSMax Laier #define ifgrq_group ifgrq_ifgrqu.ifgrqu_group 4980dad3f0eSMax Laier #define ifgrq_member ifgrq_ifgrqu.ifgrqu_member 4990dad3f0eSMax Laier }; 5000dad3f0eSMax Laier 5010dad3f0eSMax Laier /* 5020dad3f0eSMax Laier * Used to lookup groups for an interface 5030dad3f0eSMax Laier */ 5040dad3f0eSMax Laier struct ifgroupreq { 5050dad3f0eSMax Laier char ifgr_name[IFNAMSIZ]; 5060dad3f0eSMax Laier u_int ifgr_len; 5070dad3f0eSMax Laier union { 5080dad3f0eSMax Laier char ifgru_group[IFNAMSIZ]; 5090dad3f0eSMax Laier struct ifg_req *ifgru_groups; 5100dad3f0eSMax Laier } ifgr_ifgru; 5110dad3f0eSMax Laier #define ifgr_group ifgr_ifgru.ifgru_group 5120dad3f0eSMax Laier #define ifgr_groups ifgr_ifgru.ifgru_groups 5130dad3f0eSMax Laier }; 5140dad3f0eSMax Laier 515ea463f2dSAlexander V. Chernikov /* 516ea463f2dSAlexander V. Chernikov * Structure used to request i2c data 517ea463f2dSAlexander V. Chernikov * from interface transceivers. 518ea463f2dSAlexander V. Chernikov */ 519ea463f2dSAlexander V. Chernikov struct ifi2creq { 520ea463f2dSAlexander V. Chernikov uint8_t dev_addr; /* i2c address (0xA0, 0xA2) */ 521ea463f2dSAlexander V. Chernikov uint8_t offset; /* read offset */ 522ea463f2dSAlexander V. Chernikov uint8_t len; /* read length */ 523ea463f2dSAlexander V. Chernikov uint8_t spare0; 524ea463f2dSAlexander V. Chernikov uint32_t spare1; 525ea463f2dSAlexander V. Chernikov uint8_t data[8]; /* read buffer */ 526ea463f2dSAlexander V. Chernikov }; 527ea463f2dSAlexander V. Chernikov 528f2ba8326SMike Barcroft #endif /* __BSD_VISIBLE */ 529f2ba8326SMike Barcroft 530664a31e4SPeter Wemm #ifdef _KERNEL 531a1c995b6SPoul-Henning Kamp #ifdef MALLOC_DECLARE 532a1c995b6SPoul-Henning Kamp MALLOC_DECLARE(M_IFADDR); 533a1c995b6SPoul-Henning Kamp MALLOC_DECLARE(M_IFMADDR); 534a1c995b6SPoul-Henning Kamp #endif 535a1c995b6SPoul-Henning Kamp #endif 536a1c995b6SPoul-Henning Kamp 537664a31e4SPeter Wemm #ifndef _KERNEL 53876429de4SYoshinobu Inoue struct if_nameindex { 539f2ba8326SMike Barcroft unsigned int if_index; /* 1, 2, ... */ 54076429de4SYoshinobu Inoue char *if_name; /* null terminated name: "le0", ... */ 54176429de4SYoshinobu Inoue }; 54276429de4SYoshinobu Inoue 54376429de4SYoshinobu Inoue __BEGIN_DECLS 544edfcad95SMike Barcroft void if_freenameindex(struct if_nameindex *); 545f2ba8326SMike Barcroft char *if_indextoname(unsigned int, char *); 546929ddbbbSAlfred Perlstein struct if_nameindex *if_nameindex(void); 547edfcad95SMike Barcroft unsigned int if_nametoindex(const char *); 54876429de4SYoshinobu Inoue __END_DECLS 54976429de4SYoshinobu Inoue #endif 550df708ff1SBruce Evans #endif /* !_NET_IF_H_ */ 551