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 38d497e878SIan Dowse #ifdef _KERNEL 3930aad87dSBrooks Davis #include <sys/queue.h> 40d497e878SIan Dowse #endif 4130aad87dSBrooks Davis 42f2ba8326SMike Barcroft #if __BSD_VISIBLE 43df8bae1dSRodney W. Grimes /* 4409410d0fSPeter Wemm * <net/if.h> does not depend on <sys/time.h> on most other systems. This 452fa72ea7SJeroen Ruigrok van der Werven * helps userland compatibility. (struct timeval ifi_lastchange) 46cf05e311SEd Schouten * The same holds for <sys/socket.h>. (struct sockaddr ifru_addr) 4709410d0fSPeter Wemm */ 48664a31e4SPeter Wemm #ifndef _KERNEL 4909410d0fSPeter Wemm #include <sys/time.h> 50cf05e311SEd Schouten #include <sys/socket.h> 5109410d0fSPeter Wemm #endif 5209410d0fSPeter Wemm 5330aad87dSBrooks Davis struct ifnet; 54f2ba8326SMike Barcroft #endif 5530aad87dSBrooks Davis 5630aad87dSBrooks Davis /* 5730aad87dSBrooks Davis * Length of interface external name, including terminating '\0'. 5830aad87dSBrooks Davis * Note: this is the same size as a generic device's external name. 5930aad87dSBrooks Davis */ 60f2ba8326SMike Barcroft #define IF_NAMESIZE 16 61f2ba8326SMike Barcroft #if __BSD_VISIBLE 62f2ba8326SMike Barcroft #define IFNAMSIZ IF_NAMESIZE 639bf40edeSBrooks Davis #define IF_MAXUNIT 0x7fff /* historical value */ 64f2ba8326SMike Barcroft #endif 65f2ba8326SMike Barcroft #if __BSD_VISIBLE 66f2ba8326SMike Barcroft 6730aad87dSBrooks Davis /* 6830aad87dSBrooks Davis * Structure used to query names of interface cloners. 6930aad87dSBrooks Davis */ 7030aad87dSBrooks Davis 7130aad87dSBrooks Davis struct if_clonereq { 7230aad87dSBrooks Davis int ifcr_total; /* total cloners (out) */ 7330aad87dSBrooks Davis int ifcr_count; /* room for this many in user buffer */ 7430aad87dSBrooks Davis char *ifcr_buffer; /* buffer for cloner names */ 7530aad87dSBrooks Davis }; 7630aad87dSBrooks Davis 7709410d0fSPeter Wemm /* 78a73356a1SBill Fenner * Structure describing information about an interface 79a73356a1SBill Fenner * which may be of interest to management entities. 80a73356a1SBill Fenner */ 81df8bae1dSRodney W. Grimes struct if_data { 82df8bae1dSRodney W. Grimes /* generic interface information */ 83df8bae1dSRodney W. Grimes u_char ifi_type; /* ethernet, tokenring, etc */ 84995add1aSGarrett Wollman u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */ 85df8bae1dSRodney W. Grimes u_char ifi_addrlen; /* media address length */ 86df8bae1dSRodney W. Grimes u_char ifi_hdrlen; /* media header length */ 87127d7b2dSAndre Oppermann u_char ifi_link_state; /* current link state */ 8808b68b0eSGleb Smirnoff u_char ifi_vhid; /* carp vhid */ 89bec59525SBrooks Davis u_char ifi_spare_char2; /* spare byte */ 909e734b44SBrooks Davis u_char ifi_datalen; /* length of this data struct */ 91df8bae1dSRodney W. Grimes u_long ifi_mtu; /* maximum transmission unit */ 92df8bae1dSRodney W. Grimes u_long ifi_metric; /* routing metric (external only) */ 93df8bae1dSRodney W. Grimes u_long ifi_baudrate; /* linespeed */ 94df8bae1dSRodney W. Grimes /* volatile statistics */ 95df8bae1dSRodney W. Grimes u_long ifi_ipackets; /* packets received on interface */ 96df8bae1dSRodney W. Grimes u_long ifi_ierrors; /* input errors on interface */ 97df8bae1dSRodney W. Grimes u_long ifi_opackets; /* packets sent on interface */ 98df8bae1dSRodney W. Grimes u_long ifi_oerrors; /* output errors on interface */ 99df8bae1dSRodney W. Grimes u_long ifi_collisions; /* collisions on csma interfaces */ 100df8bae1dSRodney W. Grimes u_long ifi_ibytes; /* total number of octets received */ 101df8bae1dSRodney W. Grimes u_long ifi_obytes; /* total number of octets sent */ 102df8bae1dSRodney W. Grimes u_long ifi_imcasts; /* packets received via multicast */ 103df8bae1dSRodney W. Grimes u_long ifi_omcasts; /* packets sent via multicast */ 104df8bae1dSRodney W. Grimes u_long ifi_iqdrops; /* dropped on input, this interface */ 105df8bae1dSRodney W. Grimes u_long ifi_noproto; /* destined for unsupported protocol */ 10660d4ab7aSAndre Oppermann u_long ifi_hwassist; /* HW offload capabilities, see IFCAP */ 107bc9d2991SBrooks Davis time_t ifi_epoch; /* uptime at attach or stat reset */ 108e39a0280SGary Palmer struct timeval ifi_lastchange; /* time of last administrative change */ 1096f64074eSJoerg Wunsch }; 1106f64074eSJoerg Wunsch 111fc574570SRobert Watson /*- 112292ee7beSRobert Watson * Interface flags are of two types: network stack owned flags, and driver 113292ee7beSRobert Watson * owned flags. Historically, these values were stored in the same ifnet 114292ee7beSRobert Watson * flags field, but with the advent of fine-grained locking, they have been 115292ee7beSRobert Watson * broken out such that the network stack is responsible for synchronizing 116292ee7beSRobert Watson * the stack-owned fields, and the device driver the device-owned fields. 117292ee7beSRobert Watson * Both halves can perform lockless reads of the other half's field, subject 118292ee7beSRobert Watson * to accepting the involved races. 119292ee7beSRobert Watson * 120292ee7beSRobert Watson * Both sets of flags come from the same number space, and should not be 121292ee7beSRobert Watson * permitted to conflict, as they are exposed to user space via a single 122292ee7beSRobert Watson * field. 123292ee7beSRobert Watson * 124fc574570SRobert Watson * The following symbols identify read and write requirements for fields: 125fc574570SRobert Watson * 126fc574570SRobert Watson * (i) if_flags field set by device driver before attach, read-only there 127fc574570SRobert Watson * after. 128fc574570SRobert Watson * (n) if_flags field written only by the network stack, read by either the 129fc574570SRobert Watson * stack or driver. 130fc574570SRobert Watson * (d) if_drv_flags field written only by the device driver, read by either 131fc574570SRobert Watson * the stack or driver. 132292ee7beSRobert Watson */ 133fc574570SRobert Watson #define IFF_UP 0x1 /* (n) interface is up */ 134fc574570SRobert Watson #define IFF_BROADCAST 0x2 /* (i) broadcast address valid */ 135fc574570SRobert Watson #define IFF_DEBUG 0x4 /* (n) turn on debugging */ 136fc574570SRobert Watson #define IFF_LOOPBACK 0x8 /* (i) is a loopback net */ 137fc574570SRobert Watson #define IFF_POINTOPOINT 0x10 /* (i) is a point-to-point link */ 138fc574570SRobert Watson #define IFF_SMART 0x20 /* (i) interface manages own routes */ 139fc574570SRobert Watson #define IFF_DRV_RUNNING 0x40 /* (d) resources allocated */ 140fc574570SRobert Watson #define IFF_NOARP 0x80 /* (n) no address resolution protocol */ 141fc574570SRobert Watson #define IFF_PROMISC 0x100 /* (n) receive all packets */ 142fc574570SRobert Watson #define IFF_ALLMULTI 0x200 /* (n) receive all multicast packets */ 143fc574570SRobert Watson #define IFF_DRV_OACTIVE 0x400 /* (d) tx hardware queue is full */ 144fc574570SRobert Watson #define IFF_SIMPLEX 0x800 /* (i) can't hear own transmissions */ 145df8bae1dSRodney W. Grimes #define IFF_LINK0 0x1000 /* per link layer defined bit */ 146df8bae1dSRodney W. Grimes #define IFF_LINK1 0x2000 /* per link layer defined bit */ 147df8bae1dSRodney W. Grimes #define IFF_LINK2 0x4000 /* per link layer defined bit */ 14837be1da8SGarrett Wollman #define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */ 149fc574570SRobert Watson #define IFF_MULTICAST 0x8000 /* (i) supports multicast */ 1506e3cb000SWeongyo Jeong #define IFF_CANTCONFIG 0x10000 /* (i) unconfigurable using ioctl(2) */ 151fc574570SRobert Watson #define IFF_PPROMISC 0x20000 /* (n) user-requested promisc mode */ 152fc574570SRobert Watson #define IFF_MONITOR 0x40000 /* (n) user-requested monitor mode */ 153fc574570SRobert Watson #define IFF_STATICARP 0x80000 /* (n) static ARP */ 154242a8e72SRobert Watson #define IFF_DYING 0x200000 /* (n) interface is winding down */ 1555428776eSJohn Baldwin #define IFF_RENAMING 0x400000 /* (n) interface is being renamed */ 156e4fc250cSLuigi Rizzo 157292ee7beSRobert Watson /* 158292ee7beSRobert Watson * Old names for driver flags so that user space tools can continue to use 159fc574570SRobert Watson * the old (portable) names. 160292ee7beSRobert Watson */ 161292ee7beSRobert Watson #ifndef _KERNEL 162292ee7beSRobert Watson #define IFF_RUNNING IFF_DRV_RUNNING 163292ee7beSRobert Watson #define IFF_OACTIVE IFF_DRV_OACTIVE 164292ee7beSRobert Watson #endif 165292ee7beSRobert Watson 166df8bae1dSRodney W. Grimes /* flags set internally only: */ 167df8bae1dSRodney W. Grimes #define IFF_CANTCHANGE \ 168292ee7beSRobert Watson (IFF_BROADCAST|IFF_POINTOPOINT|IFF_DRV_RUNNING|IFF_DRV_OACTIVE|\ 169242a8e72SRobert Watson IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_PROMISC|\ 170c5649739SWeongyo Jeong IFF_DYING|IFF_CANTCONFIG) 171df8bae1dSRodney W. Grimes 172bb68f0afSSam Leffler /* 173127d7b2dSAndre Oppermann * Values for if_link_state. 174127d7b2dSAndre Oppermann */ 175127d7b2dSAndre Oppermann #define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */ 176127d7b2dSAndre Oppermann #define LINK_STATE_DOWN 1 /* link is down */ 177127d7b2dSAndre Oppermann #define LINK_STATE_UP 2 /* link is up */ 178127d7b2dSAndre Oppermann 179127d7b2dSAndre Oppermann /* 180bb68f0afSSam Leffler * Some convenience macros used for setting ifi_baudrate. 181bb68f0afSSam Leffler * XXX 1000 vs. 1024? --thorpej@netbsd.org 182bb68f0afSSam Leffler */ 183bb68f0afSSam Leffler #define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */ 184bb68f0afSSam Leffler #define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */ 185bb68f0afSSam Leffler #define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */ 186bb68f0afSSam Leffler 18760d4ab7aSAndre Oppermann /* 18860d4ab7aSAndre Oppermann * Capabilities that interfaces can advertise. 18960d4ab7aSAndre Oppermann * 19060d4ab7aSAndre Oppermann * struct ifnet.if_capabilities 19160d4ab7aSAndre Oppermann * contains the optional features & capabilities a particular interface 19260d4ab7aSAndre Oppermann * supports (not only the driver but also the detected hw revision). 19360d4ab7aSAndre Oppermann * Capabilities are defined by IFCAP_* below. 194d562befcSYaroslav Tykhiy * struct ifnet.if_capenable 19560d4ab7aSAndre Oppermann * contains the enabled (either by default or through ifconfig) optional 19660d4ab7aSAndre Oppermann * features & capabilities on this interface. 19760d4ab7aSAndre Oppermann * Capabilities are defined by IFCAP_* below. 19860d4ab7aSAndre Oppermann * struct if_data.ifi_hwassist in mbuf CSUM_ flag form, controlled by above 19960d4ab7aSAndre Oppermann * contains the enabled optional feature & capabilites that can be used 20060d4ab7aSAndre Oppermann * individually per packet and are specified in the mbuf pkthdr.csum_flags 20160d4ab7aSAndre Oppermann * field. IFCAP_* and CSUM_* do not match one to one and CSUM_* may be 202d562befcSYaroslav Tykhiy * more detailed or differenciated than IFCAP_*. 20360d4ab7aSAndre Oppermann * Hwassist features are defined CSUM_* in sys/mbuf.h 204c9d658e9SLuigi Rizzo * 205c9d658e9SLuigi Rizzo * Capabilities that cannot be arbitrarily changed with ifconfig/ioctl 206c9d658e9SLuigi Rizzo * are listed in IFCAP_CANTCHANGE, similar to IFF_CANTCHANGE. 207c9d658e9SLuigi Rizzo * This is not strictly necessary because the common code never 208c9d658e9SLuigi Rizzo * changes capabilities, and it is left to the individual driver 209c9d658e9SLuigi Rizzo * to do the right thing. However, having the filter here 210c9d658e9SLuigi Rizzo * avoids replication of the same code in all individual drivers. 21160d4ab7aSAndre Oppermann */ 21222893351SJack F Vogel #define IFCAP_RXCSUM 0x00001 /* can offload checksum on RX */ 21322893351SJack F Vogel #define IFCAP_TXCSUM 0x00002 /* can offload checksum on TX */ 21422893351SJack F Vogel #define IFCAP_NETCONS 0x00004 /* can be a network console */ 21522893351SJack F Vogel #define IFCAP_VLAN_MTU 0x00008 /* VLAN-compatible MTU */ 21622893351SJack F Vogel #define IFCAP_VLAN_HWTAGGING 0x00010 /* hardware VLAN tag support */ 21722893351SJack F Vogel #define IFCAP_JUMBO_MTU 0x00020 /* 9000 byte MTU supported */ 21822893351SJack F Vogel #define IFCAP_POLLING 0x00040 /* driver supports polling */ 21922893351SJack F Vogel #define IFCAP_VLAN_HWCSUM 0x00080 /* can do IFCAP_HWCSUM on VLANs */ 22022893351SJack F Vogel #define IFCAP_TSO4 0x00100 /* can do TCP Segmentation Offload */ 22122893351SJack F Vogel #define IFCAP_TSO6 0x00200 /* can do TCP6 Segmentation Offload */ 22222893351SJack F Vogel #define IFCAP_LRO 0x00400 /* can do Large Receive Offload */ 22322893351SJack F Vogel #define IFCAP_WOL_UCAST 0x00800 /* wake on any unicast frame */ 22422893351SJack F Vogel #define IFCAP_WOL_MCAST 0x01000 /* wake on any multicast frame */ 22522893351SJack F Vogel #define IFCAP_WOL_MAGIC 0x02000 /* wake on any Magic Packet */ 22622893351SJack F Vogel #define IFCAP_TOE4 0x04000 /* interface can offload TCP */ 22722893351SJack F Vogel #define IFCAP_TOE6 0x08000 /* interface can offload TCP6 */ 22822893351SJack F Vogel #define IFCAP_VLAN_HWFILTER 0x10000 /* interface hw can filter vlan tag */ 2291abcdbd1SAttilio Rao #define IFCAP_POLLING_NOCOUNT 0x20000 /* polling ticks cannot be fragmented */ 2309b76d9cbSPyun YongHyeon #define IFCAP_VLAN_HWTSO 0x40000 /* can do IFCAP_TSO on VLANs */ 2316b533b5dSQing Li #define IFCAP_LINKSTATE 0x80000 /* the runtime link state is dynamic */ 232c9d658e9SLuigi Rizzo #define IFCAP_NETMAP 0x100000 /* netmap mode supported/enabled */ 233f7d86692SJonathan Lemon 234f7d86692SJonathan Lemon #define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM) 235233dcce1SAndre Oppermann #define IFCAP_TSO (IFCAP_TSO4 | IFCAP_TSO6) 236de0abf19SSam Leffler #define IFCAP_WOL (IFCAP_WOL_UCAST | IFCAP_WOL_MCAST | IFCAP_WOL_MAGIC) 2374c908c35SKip Macy #define IFCAP_TOE (IFCAP_TOE4 | IFCAP_TOE6) 238016da741SJonathan Lemon 239c9d658e9SLuigi Rizzo #define IFCAP_CANTCHANGE (IFCAP_NETMAP) 240c9d658e9SLuigi Rizzo 241df8bae1dSRodney W. Grimes #define IFQ_MAXLEN 50 242df8bae1dSRodney W. Grimes #define IFNET_SLOWHZ 1 /* granularity is 1 second */ 243df8bae1dSRodney W. Grimes 244df8bae1dSRodney W. Grimes /* 245df8bae1dSRodney W. Grimes * Message format for use in obtaining information about interfaces 246df8bae1dSRodney W. Grimes * from getkerninfo and the routing socket 247*6d076ae8SBjoern A. Zeeb * For the new, extensible interface see struct if_msghdrl below. 248df8bae1dSRodney W. Grimes */ 249df8bae1dSRodney W. Grimes struct if_msghdr { 250df8bae1dSRodney W. Grimes u_short ifm_msglen; /* to skip over non-understood messages */ 2512fa72ea7SJeroen Ruigrok van der Werven u_char ifm_version; /* future binary compatibility */ 252df8bae1dSRodney W. Grimes u_char ifm_type; /* message type */ 253df8bae1dSRodney W. Grimes int ifm_addrs; /* like rtm_addrs */ 254df8bae1dSRodney W. Grimes int ifm_flags; /* value of if_flags */ 255df8bae1dSRodney W. Grimes u_short ifm_index; /* index for associated ifp */ 256df8bae1dSRodney W. Grimes struct if_data ifm_data;/* statistics and other data about if */ 257df8bae1dSRodney W. Grimes }; 258df8bae1dSRodney W. Grimes 259df8bae1dSRodney W. Grimes /* 260*6d076ae8SBjoern A. Zeeb * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL. It is 261*6d076ae8SBjoern A. Zeeb * extensible after ifm_data_off or within ifm_data. Both the if_msghdr and 262*6d076ae8SBjoern A. Zeeb * if_data now have a member field detailing the struct length in addition to 263*6d076ae8SBjoern A. Zeeb * the routing message length. Macros are provided to find the start of 264*6d076ae8SBjoern A. Zeeb * ifm_data and the start of the socket address strucutres immediately following 265*6d076ae8SBjoern A. Zeeb * struct if_msghdrl given a pointer to struct if_msghdrl. 266*6d076ae8SBjoern A. Zeeb */ 267*6d076ae8SBjoern A. Zeeb #define IF_MSGHDRL_IFM_DATA(_l) \ 268*6d076ae8SBjoern A. Zeeb (struct if_data *)((char *)(_l) + (_l)->ifm_data_off) 269*6d076ae8SBjoern A. Zeeb #define IF_MSGHDRL_RTA(_l) \ 270*6d076ae8SBjoern A. Zeeb (void *)((uintptr_t)(_l) + (_l)->ifm_len) 271*6d076ae8SBjoern A. Zeeb struct if_msghdrl { 272*6d076ae8SBjoern A. Zeeb u_short ifm_msglen; /* to skip over non-understood messages */ 273*6d076ae8SBjoern A. Zeeb u_char ifm_version; /* future binary compatibility */ 274*6d076ae8SBjoern A. Zeeb u_char ifm_type; /* message type */ 275*6d076ae8SBjoern A. Zeeb int ifm_addrs; /* like rtm_addrs */ 276*6d076ae8SBjoern A. Zeeb int ifm_flags; /* value of if_flags */ 277*6d076ae8SBjoern A. Zeeb u_short ifm_index; /* index for associated ifp */ 278*6d076ae8SBjoern A. Zeeb u_short _ifm_spare1; /* spare space to grow if_index, see if_var.h */ 279*6d076ae8SBjoern A. Zeeb u_short ifm_len; /* length of if_msghdrl incl. if_data */ 280*6d076ae8SBjoern A. Zeeb u_short ifm_data_off; /* offset of if_data from beginning */ 281*6d076ae8SBjoern A. Zeeb struct if_data ifm_data;/* statistics and other data about if */ 282*6d076ae8SBjoern A. Zeeb }; 283*6d076ae8SBjoern A. Zeeb 284*6d076ae8SBjoern A. Zeeb /* 285df8bae1dSRodney W. Grimes * Message format for use in obtaining information about interface addresses 286df8bae1dSRodney W. Grimes * from getkerninfo and the routing socket 287*6d076ae8SBjoern A. Zeeb * For the new, extensible interface see struct ifa_msghdrl below. 288df8bae1dSRodney W. Grimes */ 289df8bae1dSRodney W. Grimes struct ifa_msghdr { 290df8bae1dSRodney W. Grimes u_short ifam_msglen; /* to skip over non-understood messages */ 2912fa72ea7SJeroen Ruigrok van der Werven u_char ifam_version; /* future binary compatibility */ 292df8bae1dSRodney W. Grimes u_char ifam_type; /* message type */ 293df8bae1dSRodney W. Grimes int ifam_addrs; /* like rtm_addrs */ 294df8bae1dSRodney W. Grimes int ifam_flags; /* value of ifa_flags */ 295df8bae1dSRodney W. Grimes u_short ifam_index; /* index for associated ifp */ 296df8bae1dSRodney W. Grimes int ifam_metric; /* value of ifa_metric */ 297df8bae1dSRodney W. Grimes }; 298df8bae1dSRodney W. Grimes 299df8bae1dSRodney W. Grimes /* 300*6d076ae8SBjoern A. Zeeb * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL. It is 301*6d076ae8SBjoern A. Zeeb * extensible after ifam_metric or within ifam_data. Both the ifa_msghdrl and 302*6d076ae8SBjoern A. Zeeb * if_data now have a member field detailing the struct length in addition to 303*6d076ae8SBjoern A. Zeeb * the routing message length. Macros are provided to find the start of 304*6d076ae8SBjoern A. Zeeb * ifm_data and the start of the socket address strucutres immediately following 305*6d076ae8SBjoern A. Zeeb * struct ifa_msghdrl given a pointer to struct ifa_msghdrl. 306*6d076ae8SBjoern A. Zeeb */ 307*6d076ae8SBjoern A. Zeeb #define IFA_MSGHDRL_IFAM_DATA(_l) \ 308*6d076ae8SBjoern A. Zeeb (struct if_data *)((char *)(_l) + (_l)->ifam_data_off) 309*6d076ae8SBjoern A. Zeeb #define IFA_MSGHDRL_RTA(_l) \ 310*6d076ae8SBjoern A. Zeeb (void *)((uintptr_t)(_l) + (_l)->ifam_len) 311*6d076ae8SBjoern A. Zeeb struct ifa_msghdrl { 312*6d076ae8SBjoern A. Zeeb u_short ifam_msglen; /* to skip over non-understood messages */ 313*6d076ae8SBjoern A. Zeeb u_char ifam_version; /* future binary compatibility */ 314*6d076ae8SBjoern A. Zeeb u_char ifam_type; /* message type */ 315*6d076ae8SBjoern A. Zeeb int ifam_addrs; /* like rtm_addrs */ 316*6d076ae8SBjoern A. Zeeb int ifam_flags; /* value of ifa_flags */ 317*6d076ae8SBjoern A. Zeeb u_short ifam_index; /* index for associated ifp */ 318*6d076ae8SBjoern A. Zeeb u_short _ifam_spare1; /* spare space to grow if_index, see if_var.h */ 319*6d076ae8SBjoern A. Zeeb u_short ifam_len; /* length of ifa_msghdrl incl. if_data */ 320*6d076ae8SBjoern A. Zeeb u_short ifam_data_off; /* offset of if_data from beginning */ 321*6d076ae8SBjoern A. Zeeb int ifam_metric; /* value of ifa_metric */ 322*6d076ae8SBjoern A. Zeeb struct if_data ifam_data;/* statistics and other data about if or 323*6d076ae8SBjoern A. Zeeb * address */ 324*6d076ae8SBjoern A. Zeeb }; 325*6d076ae8SBjoern A. Zeeb 326*6d076ae8SBjoern A. Zeeb /* 327477180fbSGarrett Wollman * Message format for use in obtaining information about multicast addresses 328477180fbSGarrett Wollman * from the routing socket 329477180fbSGarrett Wollman */ 330477180fbSGarrett Wollman struct ifma_msghdr { 331477180fbSGarrett Wollman u_short ifmam_msglen; /* to skip over non-understood messages */ 3322fa72ea7SJeroen Ruigrok van der Werven u_char ifmam_version; /* future binary compatibility */ 333477180fbSGarrett Wollman u_char ifmam_type; /* message type */ 334477180fbSGarrett Wollman int ifmam_addrs; /* like rtm_addrs */ 335477180fbSGarrett Wollman int ifmam_flags; /* value of ifa_flags */ 336477180fbSGarrett Wollman u_short ifmam_index; /* index for associated ifp */ 337477180fbSGarrett Wollman }; 338477180fbSGarrett Wollman 339477180fbSGarrett Wollman /* 3407b6edd04SRuslan Ermilov * Message format announcing the arrival or departure of a network interface. 3417b6edd04SRuslan Ermilov */ 3427b6edd04SRuslan Ermilov struct if_announcemsghdr { 3437b6edd04SRuslan Ermilov u_short ifan_msglen; /* to skip over non-understood messages */ 3447b6edd04SRuslan Ermilov u_char ifan_version; /* future binary compatibility */ 3457b6edd04SRuslan Ermilov u_char ifan_type; /* message type */ 3467b6edd04SRuslan Ermilov u_short ifan_index; /* index for associated ifp */ 3477b6edd04SRuslan Ermilov char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 3487b6edd04SRuslan Ermilov u_short ifan_what; /* what type of announcement */ 3497b6edd04SRuslan Ermilov }; 3507b6edd04SRuslan Ermilov 3517b6edd04SRuslan Ermilov #define IFAN_ARRIVAL 0 /* interface arrival */ 3527b6edd04SRuslan Ermilov #define IFAN_DEPARTURE 1 /* interface departure */ 3537b6edd04SRuslan Ermilov 3547b6edd04SRuslan Ermilov /* 355215940b3SXin LI * Buffer with length to be used in SIOCGIFDESCR/SIOCSIFDESCR requests 356215940b3SXin LI */ 357215940b3SXin LI struct ifreq_buffer { 358215940b3SXin LI size_t length; 359215940b3SXin LI void *buffer; 360215940b3SXin LI }; 361215940b3SXin LI 362215940b3SXin LI /* 363df8bae1dSRodney W. Grimes * Interface request structure used for socket 364df8bae1dSRodney W. Grimes * ioctl's. All interface ioctl's must have parameter 365df8bae1dSRodney W. Grimes * definitions which begin with ifr_name. The 366df8bae1dSRodney W. Grimes * remainder may be interface specific. 367df8bae1dSRodney W. Grimes */ 368df8bae1dSRodney W. Grimes struct ifreq { 369df8bae1dSRodney W. Grimes char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 370df8bae1dSRodney W. Grimes union { 371df8bae1dSRodney W. Grimes struct sockaddr ifru_addr; 372df8bae1dSRodney W. Grimes struct sockaddr ifru_dstaddr; 373df8bae1dSRodney W. Grimes struct sockaddr ifru_broadaddr; 374215940b3SXin LI struct ifreq_buffer ifru_buffer; 3754add131eSPoul-Henning Kamp short ifru_flags[2]; 376de593450SJonathan Lemon short ifru_index; 377679e1390SJamie Gritton int ifru_jid; 378df8bae1dSRodney W. Grimes int ifru_metric; 379a7028af7SDavid Greenman int ifru_mtu; 380074c4a4eSGarrett Wollman int ifru_phys; 381a912e453SPeter Wemm int ifru_media; 382df8bae1dSRodney W. Grimes caddr_t ifru_data; 383016da741SJonathan Lemon int ifru_cap[2]; 38435fd7bc0SBjoern A. Zeeb u_int ifru_fib; 385df8bae1dSRodney W. Grimes } ifr_ifru; 386df8bae1dSRodney W. Grimes #define ifr_addr ifr_ifru.ifru_addr /* address */ 387df8bae1dSRodney W. Grimes #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 388df8bae1dSRodney W. Grimes #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 389215940b3SXin LI #define ifr_buffer ifr_ifru.ifru_buffer /* user supplied buffer with its length */ 39062f76486SMaxim Sobolev #define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */ 39162f76486SMaxim Sobolev #define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */ 392679e1390SJamie Gritton #define ifr_jid ifr_ifru.ifru_jid /* jail/vnet */ 393df8bae1dSRodney W. Grimes #define ifr_metric ifr_ifru.ifru_metric /* metric */ 394a7028af7SDavid Greenman #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 395511cdd16SDavid Greenman #define ifr_phys ifr_ifru.ifru_phys /* physical wire */ 396a912e453SPeter Wemm #define ifr_media ifr_ifru.ifru_media /* physical media */ 397df8bae1dSRodney W. Grimes #define ifr_data ifr_ifru.ifru_data /* for use by interface */ 398016da741SJonathan Lemon #define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */ 399016da741SJonathan Lemon #define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */ 400de593450SJonathan Lemon #define ifr_index ifr_ifru.ifru_index /* interface index */ 40135fd7bc0SBjoern A. Zeeb #define ifr_fib ifr_ifru.ifru_fib /* interface fib */ 402df8bae1dSRodney W. Grimes }; 403df8bae1dSRodney W. Grimes 404906f09bcSGarrett Wollman #define _SIZEOF_ADDR_IFREQ(ifr) \ 405906f09bcSGarrett Wollman ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \ 406906f09bcSGarrett Wollman (sizeof(struct ifreq) - sizeof(struct sockaddr) + \ 407906f09bcSGarrett Wollman (ifr).ifr_addr.sa_len) : sizeof(struct ifreq)) 408906f09bcSGarrett Wollman 409df8bae1dSRodney W. Grimes struct ifaliasreq { 410df8bae1dSRodney W. Grimes char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 411df8bae1dSRodney W. Grimes struct sockaddr ifra_addr; 412df8bae1dSRodney W. Grimes struct sockaddr ifra_broadaddr; 413df8bae1dSRodney W. Grimes struct sockaddr ifra_mask; 41408b68b0eSGleb Smirnoff int ifra_vhid; 415df8bae1dSRodney W. Grimes }; 416df8bae1dSRodney W. Grimes 41771212473SGleb Smirnoff /* Compat with pre-10.x */ 41871212473SGleb Smirnoff struct oifaliasreq { 41971212473SGleb Smirnoff char ifra_name[IFNAMSIZ]; 42071212473SGleb Smirnoff struct sockaddr ifra_addr; 42171212473SGleb Smirnoff struct sockaddr ifra_broadaddr; 42271212473SGleb Smirnoff struct sockaddr ifra_mask; 42371212473SGleb Smirnoff }; 42471212473SGleb Smirnoff 425a912e453SPeter Wemm struct ifmediareq { 426a912e453SPeter Wemm char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 427a912e453SPeter Wemm int ifm_current; /* current media options */ 428a912e453SPeter Wemm int ifm_mask; /* don't care mask */ 429a912e453SPeter Wemm int ifm_status; /* media status */ 430a912e453SPeter Wemm int ifm_active; /* active options */ 431a912e453SPeter Wemm int ifm_count; /* # entries in ifm_ulist array */ 432a912e453SPeter Wemm int *ifm_ulist; /* media words */ 433a912e453SPeter Wemm }; 434413dd0baSPoul-Henning Kamp 4358f867517SAndrew Thompson struct ifdrv { 4368f867517SAndrew Thompson char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 4378f867517SAndrew Thompson unsigned long ifd_cmd; 4388f867517SAndrew Thompson size_t ifd_len; 4398f867517SAndrew Thompson void *ifd_data; 4408f867517SAndrew Thompson }; 4418f867517SAndrew Thompson 442413dd0baSPoul-Henning Kamp /* 443413dd0baSPoul-Henning Kamp * Structure used to retrieve aux status data from interfaces. 444712020a1SBruce Evans * Kernel suppliers to this interface should respect the formatting 445413dd0baSPoul-Henning Kamp * needed by ifconfig(8): each line starts with a TAB and ends with 446712020a1SBruce Evans * a newline. The canonical example to copy and paste is in if_tun.c. 447413dd0baSPoul-Henning Kamp */ 448413dd0baSPoul-Henning Kamp 449413dd0baSPoul-Henning Kamp #define IFSTATMAX 800 /* 10 lines of text */ 450413dd0baSPoul-Henning Kamp struct ifstat { 451413dd0baSPoul-Henning Kamp char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 452413dd0baSPoul-Henning Kamp char ascii[IFSTATMAX + 1]; 453413dd0baSPoul-Henning Kamp }; 454413dd0baSPoul-Henning Kamp 455df8bae1dSRodney W. Grimes /* 456df8bae1dSRodney W. Grimes * Structure used in SIOCGIFCONF request. 457df8bae1dSRodney W. Grimes * Used to retrieve interface configuration 458df8bae1dSRodney W. Grimes * for machine (useful for programs which 459df8bae1dSRodney W. Grimes * must know all networks accessible). 460df8bae1dSRodney W. Grimes */ 461df8bae1dSRodney W. Grimes struct ifconf { 462df8bae1dSRodney W. Grimes int ifc_len; /* size of associated buffer */ 463df8bae1dSRodney W. Grimes union { 464df8bae1dSRodney W. Grimes caddr_t ifcu_buf; 465df8bae1dSRodney W. Grimes struct ifreq *ifcu_req; 466df8bae1dSRodney W. Grimes } ifc_ifcu; 467df8bae1dSRodney W. Grimes #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 468df8bae1dSRodney W. Grimes #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 469df8bae1dSRodney W. Grimes }; 470df8bae1dSRodney W. Grimes 47176429de4SYoshinobu Inoue /* 4720dad3f0eSMax Laier * interface groups 4730dad3f0eSMax Laier */ 4740dad3f0eSMax Laier 4750dad3f0eSMax Laier #define IFG_ALL "all" /* group contains all interfaces */ 4760dad3f0eSMax Laier /* XXX: will we implement this? */ 4770dad3f0eSMax Laier #define IFG_EGRESS "egress" /* if(s) default route(s) point to */ 4780dad3f0eSMax Laier 4790dad3f0eSMax Laier struct ifg_req { 4800dad3f0eSMax Laier union { 4810dad3f0eSMax Laier char ifgrqu_group[IFNAMSIZ]; 4820dad3f0eSMax Laier char ifgrqu_member[IFNAMSIZ]; 4830dad3f0eSMax Laier } ifgrq_ifgrqu; 4840dad3f0eSMax Laier #define ifgrq_group ifgrq_ifgrqu.ifgrqu_group 4850dad3f0eSMax Laier #define ifgrq_member ifgrq_ifgrqu.ifgrqu_member 4860dad3f0eSMax Laier }; 4870dad3f0eSMax Laier 4880dad3f0eSMax Laier /* 4890dad3f0eSMax Laier * Used to lookup groups for an interface 4900dad3f0eSMax Laier */ 4910dad3f0eSMax Laier struct ifgroupreq { 4920dad3f0eSMax Laier char ifgr_name[IFNAMSIZ]; 4930dad3f0eSMax Laier u_int ifgr_len; 4940dad3f0eSMax Laier union { 4950dad3f0eSMax Laier char ifgru_group[IFNAMSIZ]; 4960dad3f0eSMax Laier struct ifg_req *ifgru_groups; 4970dad3f0eSMax Laier } ifgr_ifgru; 4980dad3f0eSMax Laier #define ifgr_group ifgr_ifgru.ifgru_group 4990dad3f0eSMax Laier #define ifgr_groups ifgr_ifgru.ifgru_groups 5000dad3f0eSMax Laier }; 5010dad3f0eSMax Laier 5020dad3f0eSMax Laier /* 50376429de4SYoshinobu Inoue * Structure for SIOC[AGD]LIFADDR 50476429de4SYoshinobu Inoue */ 50576429de4SYoshinobu Inoue struct if_laddrreq { 50676429de4SYoshinobu Inoue char iflr_name[IFNAMSIZ]; 50776429de4SYoshinobu Inoue u_int flags; 50876429de4SYoshinobu Inoue #define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ 50976429de4SYoshinobu Inoue u_int prefixlen; /* in/out */ 51076429de4SYoshinobu Inoue struct sockaddr_storage addr; /* in/out */ 51176429de4SYoshinobu Inoue struct sockaddr_storage dstaddr; /* out */ 51276429de4SYoshinobu Inoue }; 51376429de4SYoshinobu Inoue 514f2ba8326SMike Barcroft #endif /* __BSD_VISIBLE */ 515f2ba8326SMike Barcroft 516664a31e4SPeter Wemm #ifdef _KERNEL 517a1c995b6SPoul-Henning Kamp #ifdef MALLOC_DECLARE 518a1c995b6SPoul-Henning Kamp MALLOC_DECLARE(M_IFADDR); 519a1c995b6SPoul-Henning Kamp MALLOC_DECLARE(M_IFMADDR); 520a1c995b6SPoul-Henning Kamp #endif 521a1c995b6SPoul-Henning Kamp #endif 522a1c995b6SPoul-Henning Kamp 523664a31e4SPeter Wemm #ifndef _KERNEL 52476429de4SYoshinobu Inoue struct if_nameindex { 525f2ba8326SMike Barcroft unsigned int if_index; /* 1, 2, ... */ 52676429de4SYoshinobu Inoue char *if_name; /* null terminated name: "le0", ... */ 52776429de4SYoshinobu Inoue }; 52876429de4SYoshinobu Inoue 52976429de4SYoshinobu Inoue __BEGIN_DECLS 530edfcad95SMike Barcroft void if_freenameindex(struct if_nameindex *); 531f2ba8326SMike Barcroft char *if_indextoname(unsigned int, char *); 532929ddbbbSAlfred Perlstein struct if_nameindex *if_nameindex(void); 533edfcad95SMike Barcroft unsigned int if_nametoindex(const char *); 53476429de4SYoshinobu Inoue __END_DECLS 53576429de4SYoshinobu Inoue #endif 53676429de4SYoshinobu Inoue 537664a31e4SPeter Wemm #ifdef _KERNEL 538712020a1SBruce Evans /* XXX - this should go away soon. */ 53919ff91c6SGarrett Wollman #include <net/if_var.h> 540df8bae1dSRodney W. Grimes #endif 541cea1da3bSPaul Richards 542df708ff1SBruce Evans #endif /* !_NET_IF_H_ */ 543