1*4a5d661aSToomas Soome /*- 2*4a5d661aSToomas Soome * Copyright (c) 1982, 1986, 1989, 1993 3*4a5d661aSToomas Soome * The Regents of the University of California. All rights reserved. 4*4a5d661aSToomas Soome * 5*4a5d661aSToomas Soome * Redistribution and use in source and binary forms, with or without 6*4a5d661aSToomas Soome * modification, are permitted provided that the following conditions 7*4a5d661aSToomas Soome * are met: 8*4a5d661aSToomas Soome * 1. Redistributions of source code must retain the above copyright 9*4a5d661aSToomas Soome * notice, this list of conditions and the following disclaimer. 10*4a5d661aSToomas Soome * 2. Redistributions in binary form must reproduce the above copyright 11*4a5d661aSToomas Soome * notice, this list of conditions and the following disclaimer in the 12*4a5d661aSToomas Soome * documentation and/or other materials provided with the distribution. 13*4a5d661aSToomas Soome * 4. Neither the name of the University nor the names of its contributors 14*4a5d661aSToomas Soome * may be used to endorse or promote products derived from this software 15*4a5d661aSToomas Soome * without specific prior written permission. 16*4a5d661aSToomas Soome * 17*4a5d661aSToomas Soome * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 18*4a5d661aSToomas Soome * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19*4a5d661aSToomas Soome * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20*4a5d661aSToomas Soome * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21*4a5d661aSToomas Soome * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22*4a5d661aSToomas Soome * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23*4a5d661aSToomas Soome * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24*4a5d661aSToomas Soome * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25*4a5d661aSToomas Soome * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26*4a5d661aSToomas Soome * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27*4a5d661aSToomas Soome * SUCH DAMAGE. 28*4a5d661aSToomas Soome * 29*4a5d661aSToomas Soome * @(#)if.h 8.1 (Berkeley) 6/10/93 30*4a5d661aSToomas Soome * $FreeBSD$ 31*4a5d661aSToomas Soome */ 32*4a5d661aSToomas Soome 33*4a5d661aSToomas Soome #ifndef _NET_IF_H_ 34*4a5d661aSToomas Soome #define _NET_IF_H_ 35*4a5d661aSToomas Soome 36*4a5d661aSToomas Soome #include <sys/cdefs.h> 37*4a5d661aSToomas Soome 38*4a5d661aSToomas Soome #if __BSD_VISIBLE 39*4a5d661aSToomas Soome /* 40*4a5d661aSToomas Soome * <net/if.h> does not depend on <sys/time.h> on most other systems. This 41*4a5d661aSToomas Soome * helps userland compatibility. (struct timeval ifi_lastchange) 42*4a5d661aSToomas Soome * The same holds for <sys/socket.h>. (struct sockaddr ifru_addr) 43*4a5d661aSToomas Soome */ 44*4a5d661aSToomas Soome #ifndef _KERNEL 45*4a5d661aSToomas Soome #include <sys/time.h> 46*4a5d661aSToomas Soome #include <sys/socket.h> 47*4a5d661aSToomas Soome #endif 48*4a5d661aSToomas Soome #endif 49*4a5d661aSToomas Soome 50*4a5d661aSToomas Soome /* 51*4a5d661aSToomas Soome * Length of interface external name, including terminating '\0'. 52*4a5d661aSToomas Soome * Note: this is the same size as a generic device's external name. 53*4a5d661aSToomas Soome */ 54*4a5d661aSToomas Soome #define IF_NAMESIZE 16 55*4a5d661aSToomas Soome #if __BSD_VISIBLE 56*4a5d661aSToomas Soome #define IFNAMSIZ IF_NAMESIZE 57*4a5d661aSToomas Soome #define IF_MAXUNIT 0x7fff /* historical value */ 58*4a5d661aSToomas Soome #endif 59*4a5d661aSToomas Soome #if __BSD_VISIBLE 60*4a5d661aSToomas Soome 61*4a5d661aSToomas Soome /* 62*4a5d661aSToomas Soome * Structure used to query names of interface cloners. 63*4a5d661aSToomas Soome */ 64*4a5d661aSToomas Soome 65*4a5d661aSToomas Soome struct if_clonereq { 66*4a5d661aSToomas Soome int ifcr_total; /* total cloners (out) */ 67*4a5d661aSToomas Soome int ifcr_count; /* room for this many in user buffer */ 68*4a5d661aSToomas Soome char *ifcr_buffer; /* buffer for cloner names */ 69*4a5d661aSToomas Soome }; 70*4a5d661aSToomas Soome 71*4a5d661aSToomas Soome /* 72*4a5d661aSToomas Soome * Structure describing information about an interface 73*4a5d661aSToomas Soome * which may be of interest to management entities. 74*4a5d661aSToomas Soome */ 75*4a5d661aSToomas Soome struct if_data { 76*4a5d661aSToomas Soome /* generic interface information */ 77*4a5d661aSToomas Soome uint8_t ifi_type; /* ethernet, tokenring, etc */ 78*4a5d661aSToomas Soome uint8_t ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */ 79*4a5d661aSToomas Soome uint8_t ifi_addrlen; /* media address length */ 80*4a5d661aSToomas Soome uint8_t ifi_hdrlen; /* media header length */ 81*4a5d661aSToomas Soome uint8_t ifi_link_state; /* current link state */ 82*4a5d661aSToomas Soome uint8_t ifi_vhid; /* carp vhid */ 83*4a5d661aSToomas Soome uint16_t ifi_datalen; /* length of this data struct */ 84*4a5d661aSToomas Soome uint32_t ifi_mtu; /* maximum transmission unit */ 85*4a5d661aSToomas Soome uint32_t ifi_metric; /* routing metric (external only) */ 86*4a5d661aSToomas Soome uint64_t ifi_baudrate; /* linespeed */ 87*4a5d661aSToomas Soome /* volatile statistics */ 88*4a5d661aSToomas Soome uint64_t ifi_ipackets; /* packets received on interface */ 89*4a5d661aSToomas Soome uint64_t ifi_ierrors; /* input errors on interface */ 90*4a5d661aSToomas Soome uint64_t ifi_opackets; /* packets sent on interface */ 91*4a5d661aSToomas Soome uint64_t ifi_oerrors; /* output errors on interface */ 92*4a5d661aSToomas Soome uint64_t ifi_collisions; /* collisions on csma interfaces */ 93*4a5d661aSToomas Soome uint64_t ifi_ibytes; /* total number of octets received */ 94*4a5d661aSToomas Soome uint64_t ifi_obytes; /* total number of octets sent */ 95*4a5d661aSToomas Soome uint64_t ifi_imcasts; /* packets received via multicast */ 96*4a5d661aSToomas Soome uint64_t ifi_omcasts; /* packets sent via multicast */ 97*4a5d661aSToomas Soome uint64_t ifi_iqdrops; /* dropped on input */ 98*4a5d661aSToomas Soome uint64_t ifi_oqdrops; /* dropped on output */ 99*4a5d661aSToomas Soome uint64_t ifi_noproto; /* destined for unsupported protocol */ 100*4a5d661aSToomas Soome uint64_t ifi_hwassist; /* HW offload capabilities, see IFCAP */ 101*4a5d661aSToomas Soome 102*4a5d661aSToomas Soome /* Unions are here to make sizes MI. */ 103*4a5d661aSToomas Soome union { /* uptime at attach or stat reset */ 104*4a5d661aSToomas Soome time_t tt; 105*4a5d661aSToomas Soome uint64_t ph; 106*4a5d661aSToomas Soome } __ifi_epoch; 107*4a5d661aSToomas Soome #define ifi_epoch __ifi_epoch.tt 108*4a5d661aSToomas Soome union { /* time of last administrative change */ 109*4a5d661aSToomas Soome struct timeval tv; 110*4a5d661aSToomas Soome struct { 111*4a5d661aSToomas Soome uint64_t ph1; 112*4a5d661aSToomas Soome uint64_t ph2; 113*4a5d661aSToomas Soome } ph; 114*4a5d661aSToomas Soome } __ifi_lastchange; 115*4a5d661aSToomas Soome #define ifi_lastchange __ifi_lastchange.tv 116*4a5d661aSToomas Soome }; 117*4a5d661aSToomas Soome 118*4a5d661aSToomas Soome /*- 119*4a5d661aSToomas Soome * Interface flags are of two types: network stack owned flags, and driver 120*4a5d661aSToomas Soome * owned flags. Historically, these values were stored in the same ifnet 121*4a5d661aSToomas Soome * flags field, but with the advent of fine-grained locking, they have been 122*4a5d661aSToomas Soome * broken out such that the network stack is responsible for synchronizing 123*4a5d661aSToomas Soome * the stack-owned fields, and the device driver the device-owned fields. 124*4a5d661aSToomas Soome * Both halves can perform lockless reads of the other half's field, subject 125*4a5d661aSToomas Soome * to accepting the involved races. 126*4a5d661aSToomas Soome * 127*4a5d661aSToomas Soome * Both sets of flags come from the same number space, and should not be 128*4a5d661aSToomas Soome * permitted to conflict, as they are exposed to user space via a single 129*4a5d661aSToomas Soome * field. 130*4a5d661aSToomas Soome * 131*4a5d661aSToomas Soome * The following symbols identify read and write requirements for fields: 132*4a5d661aSToomas Soome * 133*4a5d661aSToomas Soome * (i) if_flags field set by device driver before attach, read-only there 134*4a5d661aSToomas Soome * after. 135*4a5d661aSToomas Soome * (n) if_flags field written only by the network stack, read by either the 136*4a5d661aSToomas Soome * stack or driver. 137*4a5d661aSToomas Soome * (d) if_drv_flags field written only by the device driver, read by either 138*4a5d661aSToomas Soome * the stack or driver. 139*4a5d661aSToomas Soome */ 140*4a5d661aSToomas Soome #define IFF_UP 0x1 /* (n) interface is up */ 141*4a5d661aSToomas Soome #define IFF_BROADCAST 0x2 /* (i) broadcast address valid */ 142*4a5d661aSToomas Soome #define IFF_DEBUG 0x4 /* (n) turn on debugging */ 143*4a5d661aSToomas Soome #define IFF_LOOPBACK 0x8 /* (i) is a loopback net */ 144*4a5d661aSToomas Soome #define IFF_POINTOPOINT 0x10 /* (i) is a point-to-point link */ 145*4a5d661aSToomas Soome /* 0x20 was IFF_SMART */ 146*4a5d661aSToomas Soome #define IFF_DRV_RUNNING 0x40 /* (d) resources allocated */ 147*4a5d661aSToomas Soome #define IFF_NOARP 0x80 /* (n) no address resolution protocol */ 148*4a5d661aSToomas Soome #define IFF_PROMISC 0x100 /* (n) receive all packets */ 149*4a5d661aSToomas Soome #define IFF_ALLMULTI 0x200 /* (n) receive all multicast packets */ 150*4a5d661aSToomas Soome #define IFF_DRV_OACTIVE 0x400 /* (d) tx hardware queue is full */ 151*4a5d661aSToomas Soome #define IFF_SIMPLEX 0x800 /* (i) can't hear own transmissions */ 152*4a5d661aSToomas Soome #define IFF_LINK0 0x1000 /* per link layer defined bit */ 153*4a5d661aSToomas Soome #define IFF_LINK1 0x2000 /* per link layer defined bit */ 154*4a5d661aSToomas Soome #define IFF_LINK2 0x4000 /* per link layer defined bit */ 155*4a5d661aSToomas Soome #define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */ 156*4a5d661aSToomas Soome #define IFF_MULTICAST 0x8000 /* (i) supports multicast */ 157*4a5d661aSToomas Soome #define IFF_CANTCONFIG 0x10000 /* (i) unconfigurable using ioctl(2) */ 158*4a5d661aSToomas Soome #define IFF_PPROMISC 0x20000 /* (n) user-requested promisc mode */ 159*4a5d661aSToomas Soome #define IFF_MONITOR 0x40000 /* (n) user-requested monitor mode */ 160*4a5d661aSToomas Soome #define IFF_STATICARP 0x80000 /* (n) static ARP */ 161*4a5d661aSToomas Soome #define IFF_DYING 0x200000 /* (n) interface is winding down */ 162*4a5d661aSToomas Soome #define IFF_RENAMING 0x400000 /* (n) interface is being renamed */ 163*4a5d661aSToomas Soome /* 164*4a5d661aSToomas Soome * Old names for driver flags so that user space tools can continue to use 165*4a5d661aSToomas Soome * the old (portable) names. 166*4a5d661aSToomas Soome */ 167*4a5d661aSToomas Soome #ifndef _KERNEL 168*4a5d661aSToomas Soome #define IFF_RUNNING IFF_DRV_RUNNING 169*4a5d661aSToomas Soome #define IFF_OACTIVE IFF_DRV_OACTIVE 170*4a5d661aSToomas Soome #endif 171*4a5d661aSToomas Soome 172*4a5d661aSToomas Soome /* flags set internally only: */ 173*4a5d661aSToomas Soome #define IFF_CANTCHANGE \ 174*4a5d661aSToomas Soome (IFF_BROADCAST|IFF_POINTOPOINT|IFF_DRV_RUNNING|IFF_DRV_OACTIVE|\ 175*4a5d661aSToomas Soome IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_PROMISC|\ 176*4a5d661aSToomas Soome IFF_DYING|IFF_CANTCONFIG) 177*4a5d661aSToomas Soome 178*4a5d661aSToomas Soome /* 179*4a5d661aSToomas Soome * Values for if_link_state. 180*4a5d661aSToomas Soome */ 181*4a5d661aSToomas Soome #define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */ 182*4a5d661aSToomas Soome #define LINK_STATE_DOWN 1 /* link is down */ 183*4a5d661aSToomas Soome #define LINK_STATE_UP 2 /* link is up */ 184*4a5d661aSToomas Soome 185*4a5d661aSToomas Soome /* 186*4a5d661aSToomas Soome * Some convenience macros used for setting ifi_baudrate. 187*4a5d661aSToomas Soome * XXX 1000 vs. 1024? --thorpej@netbsd.org 188*4a5d661aSToomas Soome */ 189*4a5d661aSToomas Soome #define IF_Kbps(x) ((uintmax_t)(x) * 1000) /* kilobits/sec. */ 190*4a5d661aSToomas Soome #define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */ 191*4a5d661aSToomas Soome #define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */ 192*4a5d661aSToomas Soome 193*4a5d661aSToomas Soome /* 194*4a5d661aSToomas Soome * Capabilities that interfaces can advertise. 195*4a5d661aSToomas Soome * 196*4a5d661aSToomas Soome * struct ifnet.if_capabilities 197*4a5d661aSToomas Soome * contains the optional features & capabilities a particular interface 198*4a5d661aSToomas Soome * supports (not only the driver but also the detected hw revision). 199*4a5d661aSToomas Soome * Capabilities are defined by IFCAP_* below. 200*4a5d661aSToomas Soome * struct ifnet.if_capenable 201*4a5d661aSToomas Soome * contains the enabled (either by default or through ifconfig) optional 202*4a5d661aSToomas Soome * features & capabilities on this interface. 203*4a5d661aSToomas Soome * Capabilities are defined by IFCAP_* below. 204*4a5d661aSToomas Soome * struct if_data.ifi_hwassist in mbuf CSUM_ flag form, controlled by above 205*4a5d661aSToomas Soome * contains the enabled optional feature & capabilites that can be used 206*4a5d661aSToomas Soome * individually per packet and are specified in the mbuf pkthdr.csum_flags 207*4a5d661aSToomas Soome * field. IFCAP_* and CSUM_* do not match one to one and CSUM_* may be 208*4a5d661aSToomas Soome * more detailed or differenciated than IFCAP_*. 209*4a5d661aSToomas Soome * Hwassist features are defined CSUM_* in sys/mbuf.h 210*4a5d661aSToomas Soome * 211*4a5d661aSToomas Soome * Capabilities that cannot be arbitrarily changed with ifconfig/ioctl 212*4a5d661aSToomas Soome * are listed in IFCAP_CANTCHANGE, similar to IFF_CANTCHANGE. 213*4a5d661aSToomas Soome * This is not strictly necessary because the common code never 214*4a5d661aSToomas Soome * changes capabilities, and it is left to the individual driver 215*4a5d661aSToomas Soome * to do the right thing. However, having the filter here 216*4a5d661aSToomas Soome * avoids replication of the same code in all individual drivers. 217*4a5d661aSToomas Soome */ 218*4a5d661aSToomas Soome #define IFCAP_RXCSUM 0x00001 /* can offload checksum on RX */ 219*4a5d661aSToomas Soome #define IFCAP_TXCSUM 0x00002 /* can offload checksum on TX */ 220*4a5d661aSToomas Soome #define IFCAP_NETCONS 0x00004 /* can be a network console */ 221*4a5d661aSToomas Soome #define IFCAP_VLAN_MTU 0x00008 /* VLAN-compatible MTU */ 222*4a5d661aSToomas Soome #define IFCAP_VLAN_HWTAGGING 0x00010 /* hardware VLAN tag support */ 223*4a5d661aSToomas Soome #define IFCAP_JUMBO_MTU 0x00020 /* 9000 byte MTU supported */ 224*4a5d661aSToomas Soome #define IFCAP_POLLING 0x00040 /* driver supports polling */ 225*4a5d661aSToomas Soome #define IFCAP_VLAN_HWCSUM 0x00080 /* can do IFCAP_HWCSUM on VLANs */ 226*4a5d661aSToomas Soome #define IFCAP_TSO4 0x00100 /* can do TCP Segmentation Offload */ 227*4a5d661aSToomas Soome #define IFCAP_TSO6 0x00200 /* can do TCP6 Segmentation Offload */ 228*4a5d661aSToomas Soome #define IFCAP_LRO 0x00400 /* can do Large Receive Offload */ 229*4a5d661aSToomas Soome #define IFCAP_WOL_UCAST 0x00800 /* wake on any unicast frame */ 230*4a5d661aSToomas Soome #define IFCAP_WOL_MCAST 0x01000 /* wake on any multicast frame */ 231*4a5d661aSToomas Soome #define IFCAP_WOL_MAGIC 0x02000 /* wake on any Magic Packet */ 232*4a5d661aSToomas Soome #define IFCAP_TOE4 0x04000 /* interface can offload TCP */ 233*4a5d661aSToomas Soome #define IFCAP_TOE6 0x08000 /* interface can offload TCP6 */ 234*4a5d661aSToomas Soome #define IFCAP_VLAN_HWFILTER 0x10000 /* interface hw can filter vlan tag */ 235*4a5d661aSToomas Soome #define IFCAP_POLLING_NOCOUNT 0x20000 /* polling ticks cannot be fragmented */ 236*4a5d661aSToomas Soome #define IFCAP_VLAN_HWTSO 0x40000 /* can do IFCAP_TSO on VLANs */ 237*4a5d661aSToomas Soome #define IFCAP_LINKSTATE 0x80000 /* the runtime link state is dynamic */ 238*4a5d661aSToomas Soome #define IFCAP_NETMAP 0x100000 /* netmap mode supported/enabled */ 239*4a5d661aSToomas Soome #define IFCAP_RXCSUM_IPV6 0x200000 /* can offload checksum on IPv6 RX */ 240*4a5d661aSToomas Soome #define IFCAP_TXCSUM_IPV6 0x400000 /* can offload checksum on IPv6 TX */ 241*4a5d661aSToomas Soome #define IFCAP_HWSTATS 0x800000 /* manages counters internally */ 242*4a5d661aSToomas Soome 243*4a5d661aSToomas Soome #define IFCAP_HWCSUM_IPV6 (IFCAP_RXCSUM_IPV6 | IFCAP_TXCSUM_IPV6) 244*4a5d661aSToomas Soome 245*4a5d661aSToomas Soome #define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM) 246*4a5d661aSToomas Soome #define IFCAP_TSO (IFCAP_TSO4 | IFCAP_TSO6) 247*4a5d661aSToomas Soome #define IFCAP_WOL (IFCAP_WOL_UCAST | IFCAP_WOL_MCAST | IFCAP_WOL_MAGIC) 248*4a5d661aSToomas Soome #define IFCAP_TOE (IFCAP_TOE4 | IFCAP_TOE6) 249*4a5d661aSToomas Soome 250*4a5d661aSToomas Soome #define IFCAP_CANTCHANGE (IFCAP_NETMAP) 251*4a5d661aSToomas Soome 252*4a5d661aSToomas Soome #define IFQ_MAXLEN 50 253*4a5d661aSToomas Soome #define IFNET_SLOWHZ 1 /* granularity is 1 second */ 254*4a5d661aSToomas Soome 255*4a5d661aSToomas Soome /* 256*4a5d661aSToomas Soome * Message format for use in obtaining information about interfaces 257*4a5d661aSToomas Soome * from getkerninfo and the routing socket 258*4a5d661aSToomas Soome * For the new, extensible interface see struct if_msghdrl below. 259*4a5d661aSToomas Soome */ 260*4a5d661aSToomas Soome struct if_msghdr { 261*4a5d661aSToomas Soome u_short ifm_msglen; /* to skip over non-understood messages */ 262*4a5d661aSToomas Soome u_char ifm_version; /* future binary compatibility */ 263*4a5d661aSToomas Soome u_char ifm_type; /* message type */ 264*4a5d661aSToomas Soome int ifm_addrs; /* like rtm_addrs */ 265*4a5d661aSToomas Soome int ifm_flags; /* value of if_flags */ 266*4a5d661aSToomas Soome u_short ifm_index; /* index for associated ifp */ 267*4a5d661aSToomas Soome struct if_data ifm_data;/* statistics and other data about if */ 268*4a5d661aSToomas Soome }; 269*4a5d661aSToomas Soome 270*4a5d661aSToomas Soome /* 271*4a5d661aSToomas Soome * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL. It is 272*4a5d661aSToomas Soome * extensible after ifm_data_off or within ifm_data. Both the if_msghdr and 273*4a5d661aSToomas Soome * if_data now have a member field detailing the struct length in addition to 274*4a5d661aSToomas Soome * the routing message length. Macros are provided to find the start of 275*4a5d661aSToomas Soome * ifm_data and the start of the socket address strucutres immediately following 276*4a5d661aSToomas Soome * struct if_msghdrl given a pointer to struct if_msghdrl. 277*4a5d661aSToomas Soome */ 278*4a5d661aSToomas Soome #define IF_MSGHDRL_IFM_DATA(_l) \ 279*4a5d661aSToomas Soome (struct if_data *)((char *)(_l) + (_l)->ifm_data_off) 280*4a5d661aSToomas Soome #define IF_MSGHDRL_RTA(_l) \ 281*4a5d661aSToomas Soome (void *)((uintptr_t)(_l) + (_l)->ifm_len) 282*4a5d661aSToomas Soome struct if_msghdrl { 283*4a5d661aSToomas Soome u_short ifm_msglen; /* to skip over non-understood messages */ 284*4a5d661aSToomas Soome u_char ifm_version; /* future binary compatibility */ 285*4a5d661aSToomas Soome u_char ifm_type; /* message type */ 286*4a5d661aSToomas Soome int ifm_addrs; /* like rtm_addrs */ 287*4a5d661aSToomas Soome int ifm_flags; /* value of if_flags */ 288*4a5d661aSToomas Soome u_short ifm_index; /* index for associated ifp */ 289*4a5d661aSToomas Soome u_short _ifm_spare1; /* spare space to grow if_index, see if_var.h */ 290*4a5d661aSToomas Soome u_short ifm_len; /* length of if_msghdrl incl. if_data */ 291*4a5d661aSToomas Soome u_short ifm_data_off; /* offset of if_data from beginning */ 292*4a5d661aSToomas Soome struct if_data ifm_data;/* statistics and other data about if */ 293*4a5d661aSToomas Soome }; 294*4a5d661aSToomas Soome 295*4a5d661aSToomas Soome /* 296*4a5d661aSToomas Soome * Message format for use in obtaining information about interface addresses 297*4a5d661aSToomas Soome * from getkerninfo and the routing socket 298*4a5d661aSToomas Soome * For the new, extensible interface see struct ifa_msghdrl below. 299*4a5d661aSToomas Soome */ 300*4a5d661aSToomas Soome struct ifa_msghdr { 301*4a5d661aSToomas Soome u_short ifam_msglen; /* to skip over non-understood messages */ 302*4a5d661aSToomas Soome u_char ifam_version; /* future binary compatibility */ 303*4a5d661aSToomas Soome u_char ifam_type; /* message type */ 304*4a5d661aSToomas Soome int ifam_addrs; /* like rtm_addrs */ 305*4a5d661aSToomas Soome int ifam_flags; /* value of ifa_flags */ 306*4a5d661aSToomas Soome u_short ifam_index; /* index for associated ifp */ 307*4a5d661aSToomas Soome int ifam_metric; /* value of ifa_ifp->if_metric */ 308*4a5d661aSToomas Soome }; 309*4a5d661aSToomas Soome 310*4a5d661aSToomas Soome /* 311*4a5d661aSToomas Soome * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL. It is 312*4a5d661aSToomas Soome * extensible after ifam_metric or within ifam_data. Both the ifa_msghdrl and 313*4a5d661aSToomas Soome * if_data now have a member field detailing the struct length in addition to 314*4a5d661aSToomas Soome * the routing message length. Macros are provided to find the start of 315*4a5d661aSToomas Soome * ifm_data and the start of the socket address strucutres immediately following 316*4a5d661aSToomas Soome * struct ifa_msghdrl given a pointer to struct ifa_msghdrl. 317*4a5d661aSToomas Soome */ 318*4a5d661aSToomas Soome #define IFA_MSGHDRL_IFAM_DATA(_l) \ 319*4a5d661aSToomas Soome (struct if_data *)((char *)(_l) + (_l)->ifam_data_off) 320*4a5d661aSToomas Soome #define IFA_MSGHDRL_RTA(_l) \ 321*4a5d661aSToomas Soome (void *)((uintptr_t)(_l) + (_l)->ifam_len) 322*4a5d661aSToomas Soome struct ifa_msghdrl { 323*4a5d661aSToomas Soome u_short ifam_msglen; /* to skip over non-understood messages */ 324*4a5d661aSToomas Soome u_char ifam_version; /* future binary compatibility */ 325*4a5d661aSToomas Soome u_char ifam_type; /* message type */ 326*4a5d661aSToomas Soome int ifam_addrs; /* like rtm_addrs */ 327*4a5d661aSToomas Soome int ifam_flags; /* value of ifa_flags */ 328*4a5d661aSToomas Soome u_short ifam_index; /* index for associated ifp */ 329*4a5d661aSToomas Soome u_short _ifam_spare1; /* spare space to grow if_index, see if_var.h */ 330*4a5d661aSToomas Soome u_short ifam_len; /* length of ifa_msghdrl incl. if_data */ 331*4a5d661aSToomas Soome u_short ifam_data_off; /* offset of if_data from beginning */ 332*4a5d661aSToomas Soome int ifam_metric; /* value of ifa_ifp->if_metric */ 333*4a5d661aSToomas Soome struct if_data ifam_data;/* statistics and other data about if or 334*4a5d661aSToomas Soome * address */ 335*4a5d661aSToomas Soome }; 336*4a5d661aSToomas Soome 337*4a5d661aSToomas Soome /* 338*4a5d661aSToomas Soome * Message format for use in obtaining information about multicast addresses 339*4a5d661aSToomas Soome * from the routing socket 340*4a5d661aSToomas Soome */ 341*4a5d661aSToomas Soome struct ifma_msghdr { 342*4a5d661aSToomas Soome u_short ifmam_msglen; /* to skip over non-understood messages */ 343*4a5d661aSToomas Soome u_char ifmam_version; /* future binary compatibility */ 344*4a5d661aSToomas Soome u_char ifmam_type; /* message type */ 345*4a5d661aSToomas Soome int ifmam_addrs; /* like rtm_addrs */ 346*4a5d661aSToomas Soome int ifmam_flags; /* value of ifa_flags */ 347*4a5d661aSToomas Soome u_short ifmam_index; /* index for associated ifp */ 348*4a5d661aSToomas Soome }; 349*4a5d661aSToomas Soome 350*4a5d661aSToomas Soome /* 351*4a5d661aSToomas Soome * Message format announcing the arrival or departure of a network interface. 352*4a5d661aSToomas Soome */ 353*4a5d661aSToomas Soome struct if_announcemsghdr { 354*4a5d661aSToomas Soome u_short ifan_msglen; /* to skip over non-understood messages */ 355*4a5d661aSToomas Soome u_char ifan_version; /* future binary compatibility */ 356*4a5d661aSToomas Soome u_char ifan_type; /* message type */ 357*4a5d661aSToomas Soome u_short ifan_index; /* index for associated ifp */ 358*4a5d661aSToomas Soome char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 359*4a5d661aSToomas Soome u_short ifan_what; /* what type of announcement */ 360*4a5d661aSToomas Soome }; 361*4a5d661aSToomas Soome 362*4a5d661aSToomas Soome #define IFAN_ARRIVAL 0 /* interface arrival */ 363*4a5d661aSToomas Soome #define IFAN_DEPARTURE 1 /* interface departure */ 364*4a5d661aSToomas Soome 365*4a5d661aSToomas Soome /* 366*4a5d661aSToomas Soome * Buffer with length to be used in SIOCGIFDESCR/SIOCSIFDESCR requests 367*4a5d661aSToomas Soome */ 368*4a5d661aSToomas Soome struct ifreq_buffer { 369*4a5d661aSToomas Soome size_t length; 370*4a5d661aSToomas Soome void *buffer; 371*4a5d661aSToomas Soome }; 372*4a5d661aSToomas Soome 373*4a5d661aSToomas Soome /* 374*4a5d661aSToomas Soome * Interface request structure used for socket 375*4a5d661aSToomas Soome * ioctl's. All interface ioctl's must have parameter 376*4a5d661aSToomas Soome * definitions which begin with ifr_name. The 377*4a5d661aSToomas Soome * remainder may be interface specific. 378*4a5d661aSToomas Soome */ 379*4a5d661aSToomas Soome struct ifreq { 380*4a5d661aSToomas Soome char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 381*4a5d661aSToomas Soome union { 382*4a5d661aSToomas Soome struct sockaddr ifru_addr; 383*4a5d661aSToomas Soome struct sockaddr ifru_dstaddr; 384*4a5d661aSToomas Soome struct sockaddr ifru_broadaddr; 385*4a5d661aSToomas Soome struct ifreq_buffer ifru_buffer; 386*4a5d661aSToomas Soome short ifru_flags[2]; 387*4a5d661aSToomas Soome short ifru_index; 388*4a5d661aSToomas Soome int ifru_jid; 389*4a5d661aSToomas Soome int ifru_metric; 390*4a5d661aSToomas Soome int ifru_mtu; 391*4a5d661aSToomas Soome int ifru_phys; 392*4a5d661aSToomas Soome int ifru_media; 393*4a5d661aSToomas Soome caddr_t ifru_data; 394*4a5d661aSToomas Soome int ifru_cap[2]; 395*4a5d661aSToomas Soome u_int ifru_fib; 396*4a5d661aSToomas Soome } ifr_ifru; 397*4a5d661aSToomas Soome #define ifr_addr ifr_ifru.ifru_addr /* address */ 398*4a5d661aSToomas Soome #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 399*4a5d661aSToomas Soome #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 400*4a5d661aSToomas Soome #define ifr_buffer ifr_ifru.ifru_buffer /* user supplied buffer with its length */ 401*4a5d661aSToomas Soome #define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */ 402*4a5d661aSToomas Soome #define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */ 403*4a5d661aSToomas Soome #define ifr_jid ifr_ifru.ifru_jid /* jail/vnet */ 404*4a5d661aSToomas Soome #define ifr_metric ifr_ifru.ifru_metric /* metric */ 405*4a5d661aSToomas Soome #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 406*4a5d661aSToomas Soome #define ifr_phys ifr_ifru.ifru_phys /* physical wire */ 407*4a5d661aSToomas Soome #define ifr_media ifr_ifru.ifru_media /* physical media */ 408*4a5d661aSToomas Soome #define ifr_data ifr_ifru.ifru_data /* for use by interface */ 409*4a5d661aSToomas Soome #define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */ 410*4a5d661aSToomas Soome #define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */ 411*4a5d661aSToomas Soome #define ifr_index ifr_ifru.ifru_index /* interface index */ 412*4a5d661aSToomas Soome #define ifr_fib ifr_ifru.ifru_fib /* interface fib */ 413*4a5d661aSToomas Soome }; 414*4a5d661aSToomas Soome 415*4a5d661aSToomas Soome #define _SIZEOF_ADDR_IFREQ(ifr) \ 416*4a5d661aSToomas Soome ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \ 417*4a5d661aSToomas Soome (sizeof(struct ifreq) - sizeof(struct sockaddr) + \ 418*4a5d661aSToomas Soome (ifr).ifr_addr.sa_len) : sizeof(struct ifreq)) 419*4a5d661aSToomas Soome 420*4a5d661aSToomas Soome struct ifaliasreq { 421*4a5d661aSToomas Soome char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 422*4a5d661aSToomas Soome struct sockaddr ifra_addr; 423*4a5d661aSToomas Soome struct sockaddr ifra_broadaddr; 424*4a5d661aSToomas Soome struct sockaddr ifra_mask; 425*4a5d661aSToomas Soome int ifra_vhid; 426*4a5d661aSToomas Soome }; 427*4a5d661aSToomas Soome 428*4a5d661aSToomas Soome /* 9.x compat */ 429*4a5d661aSToomas Soome struct oifaliasreq { 430*4a5d661aSToomas Soome char ifra_name[IFNAMSIZ]; 431*4a5d661aSToomas Soome struct sockaddr ifra_addr; 432*4a5d661aSToomas Soome struct sockaddr ifra_broadaddr; 433*4a5d661aSToomas Soome struct sockaddr ifra_mask; 434*4a5d661aSToomas Soome }; 435*4a5d661aSToomas Soome 436*4a5d661aSToomas Soome struct ifmediareq { 437*4a5d661aSToomas Soome char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 438*4a5d661aSToomas Soome int ifm_current; /* current media options */ 439*4a5d661aSToomas Soome int ifm_mask; /* don't care mask */ 440*4a5d661aSToomas Soome int ifm_status; /* media status */ 441*4a5d661aSToomas Soome int ifm_active; /* active options */ 442*4a5d661aSToomas Soome int ifm_count; /* # entries in ifm_ulist array */ 443*4a5d661aSToomas Soome int *ifm_ulist; /* media words */ 444*4a5d661aSToomas Soome }; 445*4a5d661aSToomas Soome 446*4a5d661aSToomas Soome struct ifdrv { 447*4a5d661aSToomas Soome char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 448*4a5d661aSToomas Soome unsigned long ifd_cmd; 449*4a5d661aSToomas Soome size_t ifd_len; 450*4a5d661aSToomas Soome void *ifd_data; 451*4a5d661aSToomas Soome }; 452*4a5d661aSToomas Soome 453*4a5d661aSToomas Soome /* 454*4a5d661aSToomas Soome * Structure used to retrieve aux status data from interfaces. 455*4a5d661aSToomas Soome * Kernel suppliers to this interface should respect the formatting 456*4a5d661aSToomas Soome * needed by ifconfig(8): each line starts with a TAB and ends with 457*4a5d661aSToomas Soome * a newline. The canonical example to copy and paste is in if_tun.c. 458*4a5d661aSToomas Soome */ 459*4a5d661aSToomas Soome 460*4a5d661aSToomas Soome #define IFSTATMAX 800 /* 10 lines of text */ 461*4a5d661aSToomas Soome struct ifstat { 462*4a5d661aSToomas Soome char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 463*4a5d661aSToomas Soome char ascii[IFSTATMAX + 1]; 464*4a5d661aSToomas Soome }; 465*4a5d661aSToomas Soome 466*4a5d661aSToomas Soome /* 467*4a5d661aSToomas Soome * Structure used in SIOCGIFCONF request. 468*4a5d661aSToomas Soome * Used to retrieve interface configuration 469*4a5d661aSToomas Soome * for machine (useful for programs which 470*4a5d661aSToomas Soome * must know all networks accessible). 471*4a5d661aSToomas Soome */ 472*4a5d661aSToomas Soome struct ifconf { 473*4a5d661aSToomas Soome int ifc_len; /* size of associated buffer */ 474*4a5d661aSToomas Soome union { 475*4a5d661aSToomas Soome caddr_t ifcu_buf; 476*4a5d661aSToomas Soome struct ifreq *ifcu_req; 477*4a5d661aSToomas Soome } ifc_ifcu; 478*4a5d661aSToomas Soome #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 479*4a5d661aSToomas Soome #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 480*4a5d661aSToomas Soome }; 481*4a5d661aSToomas Soome 482*4a5d661aSToomas Soome /* 483*4a5d661aSToomas Soome * interface groups 484*4a5d661aSToomas Soome */ 485*4a5d661aSToomas Soome 486*4a5d661aSToomas Soome #define IFG_ALL "all" /* group contains all interfaces */ 487*4a5d661aSToomas Soome /* XXX: will we implement this? */ 488*4a5d661aSToomas Soome #define IFG_EGRESS "egress" /* if(s) default route(s) point to */ 489*4a5d661aSToomas Soome 490*4a5d661aSToomas Soome struct ifg_req { 491*4a5d661aSToomas Soome union { 492*4a5d661aSToomas Soome char ifgrqu_group[IFNAMSIZ]; 493*4a5d661aSToomas Soome char ifgrqu_member[IFNAMSIZ]; 494*4a5d661aSToomas Soome } ifgrq_ifgrqu; 495*4a5d661aSToomas Soome #define ifgrq_group ifgrq_ifgrqu.ifgrqu_group 496*4a5d661aSToomas Soome #define ifgrq_member ifgrq_ifgrqu.ifgrqu_member 497*4a5d661aSToomas Soome }; 498*4a5d661aSToomas Soome 499*4a5d661aSToomas Soome /* 500*4a5d661aSToomas Soome * Used to lookup groups for an interface 501*4a5d661aSToomas Soome */ 502*4a5d661aSToomas Soome struct ifgroupreq { 503*4a5d661aSToomas Soome char ifgr_name[IFNAMSIZ]; 504*4a5d661aSToomas Soome u_int ifgr_len; 505*4a5d661aSToomas Soome union { 506*4a5d661aSToomas Soome char ifgru_group[IFNAMSIZ]; 507*4a5d661aSToomas Soome struct ifg_req *ifgru_groups; 508*4a5d661aSToomas Soome } ifgr_ifgru; 509*4a5d661aSToomas Soome #define ifgr_group ifgr_ifgru.ifgru_group 510*4a5d661aSToomas Soome #define ifgr_groups ifgr_ifgru.ifgru_groups 511*4a5d661aSToomas Soome }; 512*4a5d661aSToomas Soome 513*4a5d661aSToomas Soome /* 514*4a5d661aSToomas Soome * Structure used to request i2c data 515*4a5d661aSToomas Soome * from interface transceivers. 516*4a5d661aSToomas Soome */ 517*4a5d661aSToomas Soome struct ifi2creq { 518*4a5d661aSToomas Soome uint8_t dev_addr; /* i2c address (0xA0, 0xA2) */ 519*4a5d661aSToomas Soome uint8_t offset; /* read offset */ 520*4a5d661aSToomas Soome uint8_t len; /* read length */ 521*4a5d661aSToomas Soome uint8_t spare0; 522*4a5d661aSToomas Soome uint32_t spare1; 523*4a5d661aSToomas Soome uint8_t data[8]; /* read buffer */ 524*4a5d661aSToomas Soome }; 525*4a5d661aSToomas Soome 526*4a5d661aSToomas Soome #endif /* __BSD_VISIBLE */ 527*4a5d661aSToomas Soome 528*4a5d661aSToomas Soome #ifdef _KERNEL 529*4a5d661aSToomas Soome #ifdef MALLOC_DECLARE 530*4a5d661aSToomas Soome MALLOC_DECLARE(M_IFADDR); 531*4a5d661aSToomas Soome MALLOC_DECLARE(M_IFMADDR); 532*4a5d661aSToomas Soome #endif 533*4a5d661aSToomas Soome #endif 534*4a5d661aSToomas Soome 535*4a5d661aSToomas Soome #ifndef _KERNEL 536*4a5d661aSToomas Soome struct if_nameindex { 537*4a5d661aSToomas Soome unsigned int if_index; /* 1, 2, ... */ 538*4a5d661aSToomas Soome char *if_name; /* null terminated name: "le0", ... */ 539*4a5d661aSToomas Soome }; 540*4a5d661aSToomas Soome 541*4a5d661aSToomas Soome __BEGIN_DECLS 542*4a5d661aSToomas Soome void if_freenameindex(struct if_nameindex *); 543*4a5d661aSToomas Soome char *if_indextoname(unsigned int, char *); 544*4a5d661aSToomas Soome struct if_nameindex *if_nameindex(void); 545*4a5d661aSToomas Soome unsigned int if_nametoindex(const char *); 546*4a5d661aSToomas Soome __END_DECLS 547*4a5d661aSToomas Soome #endif 548*4a5d661aSToomas Soome #endif /* !_NET_IF_H_ */ 549