1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1982, 1986, 1989, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32 #ifndef _NET_IF_H_ 33 #define _NET_IF_H_ 34 35 #include <sys/cdefs.h> 36 37 #if __BSD_VISIBLE 38 /* 39 * <net/if.h> does not depend on <sys/time.h> on most other systems. This 40 * helps userland compatibility. (struct timeval ifi_lastchange) 41 * The same holds for <sys/socket.h>. (struct sockaddr ifru_addr) 42 */ 43 #ifndef _KERNEL 44 #include <sys/time.h> 45 #include <sys/socket.h> 46 #endif 47 #endif 48 49 /* 50 * Length of interface external name, including terminating '\0'. 51 * Note: this is the same size as a generic device's external name. 52 */ 53 #define IF_NAMESIZE 16 54 #if __BSD_VISIBLE 55 #define IFNAMSIZ IF_NAMESIZE 56 #define IF_MAXUNIT 0x7fff /* historical value */ 57 #endif 58 #if __BSD_VISIBLE 59 60 /* 61 * Structure used to query names of interface cloners. 62 */ 63 64 struct if_clonereq { 65 int ifcr_total; /* total cloners (out) */ 66 int ifcr_count; /* room for this many in user buffer */ 67 char *ifcr_buffer; /* buffer for cloner names */ 68 }; 69 70 /* 71 * Structure describing information about an interface 72 * which may be of interest to management entities. 73 */ 74 struct if_data { 75 /* generic interface information */ 76 uint8_t ifi_type; /* ethernet, tokenring, etc */ 77 uint8_t ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */ 78 uint8_t ifi_addrlen; /* media address length */ 79 uint8_t ifi_hdrlen; /* media header length */ 80 uint8_t ifi_link_state; /* current link state */ 81 uint8_t ifi_vhid; /* carp vhid */ 82 uint16_t ifi_datalen; /* length of this data struct */ 83 uint32_t ifi_mtu; /* maximum transmission unit */ 84 uint32_t ifi_metric; /* routing metric (external only) */ 85 uint64_t ifi_baudrate; /* linespeed */ 86 /* volatile statistics */ 87 uint64_t ifi_ipackets; /* packets received on interface */ 88 uint64_t ifi_ierrors; /* input errors on interface */ 89 uint64_t ifi_opackets; /* packets sent on interface */ 90 uint64_t ifi_oerrors; /* output errors on interface */ 91 uint64_t ifi_collisions; /* collisions on csma interfaces */ 92 uint64_t ifi_ibytes; /* total number of octets received */ 93 uint64_t ifi_obytes; /* total number of octets sent */ 94 uint64_t ifi_imcasts; /* packets received via multicast */ 95 uint64_t ifi_omcasts; /* packets sent via multicast */ 96 uint64_t ifi_iqdrops; /* dropped on input */ 97 uint64_t ifi_oqdrops; /* dropped on output */ 98 uint64_t ifi_noproto; /* destined for unsupported protocol */ 99 uint64_t ifi_hwassist; /* HW offload capabilities, see IFCAP */ 100 101 /* Unions are here to make sizes MI. */ 102 union { /* uptime at attach or stat reset */ 103 time_t tt; 104 uint64_t ph; 105 } __ifi_epoch; 106 #define ifi_epoch __ifi_epoch.tt 107 union { /* time of last administrative change */ 108 struct timeval tv; 109 struct { 110 uint64_t ph1; 111 uint64_t ph2; 112 } ph; 113 } __ifi_lastchange; 114 #define ifi_lastchange __ifi_lastchange.tv 115 }; 116 117 /*- 118 * Interface flags are of two types: network stack owned flags, and driver 119 * owned flags. Historically, these values were stored in the same ifnet 120 * flags field, but with the advent of fine-grained locking, they have been 121 * broken out such that the network stack is responsible for synchronizing 122 * the stack-owned fields, and the device driver the device-owned fields. 123 * Both halves can perform lockless reads of the other half's field, subject 124 * to accepting the involved races. 125 * 126 * Both sets of flags come from the same number space, and should not be 127 * permitted to conflict, as they are exposed to user space via a single 128 * field. 129 * 130 * The following symbols identify read and write requirements for fields: 131 * 132 * (i) if_flags field set by device driver before attach, read-only there 133 * after. 134 * (n) if_flags field written only by the network stack, read by either the 135 * stack or driver. 136 * (d) if_drv_flags field written only by the device driver, read by either 137 * the stack or driver. 138 */ 139 #define IFF_UP 0x1 /* (n) interface is up */ 140 #define IFF_BROADCAST 0x2 /* (i) broadcast address valid */ 141 #define IFF_DEBUG 0x4 /* (n) turn on debugging */ 142 #define IFF_LOOPBACK 0x8 /* (i) is a loopback net */ 143 #define IFF_POINTOPOINT 0x10 /* (i) is a point-to-point link */ 144 #define IFF_NEEDSEPOCH 0x20 /* (i) calls if_input w/o net epoch */ 145 #define IFF_DRV_RUNNING 0x40 /* (d) resources allocated */ 146 #define IFF_NOARP 0x80 /* (n) no address resolution protocol */ 147 #define IFF_PROMISC 0x100 /* (n) receive all packets */ 148 #define IFF_ALLMULTI 0x200 /* (n) receive all multicast packets */ 149 #define IFF_DRV_OACTIVE 0x400 /* (d) tx hardware queue is full */ 150 #define IFF_SIMPLEX 0x800 /* (i) can't hear own transmissions */ 151 #define IFF_LINK0 0x1000 /* per link layer defined bit */ 152 #define IFF_LINK1 0x2000 /* per link layer defined bit */ 153 #define IFF_LINK2 0x4000 /* per link layer defined bit */ 154 #define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */ 155 #define IFF_MULTICAST 0x8000 /* (i) supports multicast */ 156 #define IFF_CANTCONFIG 0x10000 /* (i) unconfigurable using ioctl(2) */ 157 #define IFF_PPROMISC 0x20000 /* (n) user-requested promisc mode */ 158 #define IFF_MONITOR 0x40000 /* (n) user-requested monitor mode */ 159 #define IFF_STATICARP 0x80000 /* (n) static ARP */ 160 #define IFF_STICKYARP 0x100000 /* (n) sticky ARP */ 161 #define IFF_DYING 0x200000 /* (n) interface is winding down */ 162 #define IFF_PALLMULTI 0x800000 /* (n) user-requested allmulti mode */ 163 #define IFF_NETLINK_1 0x1000000 /* (n) used by netlink */ 164 165 /* 166 * Old names for driver flags so that user space tools can continue to use 167 * the old (portable) names. 168 */ 169 #ifndef _KERNEL 170 #define IFF_RUNNING IFF_DRV_RUNNING 171 #define IFF_OACTIVE IFF_DRV_OACTIVE 172 #endif 173 174 /* flags set internally only: */ 175 #define IFF_CANTCHANGE \ 176 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_DRV_RUNNING|IFF_DRV_OACTIVE|\ 177 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_PROMISC|\ 178 IFF_DYING|IFF_CANTCONFIG|IFF_NEEDSEPOCH) 179 180 /* 181 * Values for if_link_state. 182 */ 183 #define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */ 184 #define LINK_STATE_DOWN 1 /* link is down */ 185 #define LINK_STATE_UP 2 /* link is up */ 186 187 /* 188 * Some convenience macros used for setting ifi_baudrate. 189 * XXX 1000 vs. 1024? --thorpej@netbsd.org 190 */ 191 #define IF_Kbps(x) ((uintmax_t)(x) * 1000) /* kilobits/sec. */ 192 #define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */ 193 #define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */ 194 195 /* 196 * Capabilities that interfaces can advertise. 197 * 198 * struct ifnet.if_capabilities 199 * contains the optional features & capabilities a particular interface 200 * supports (not only the driver but also the detected hw revision). 201 * Capabilities are defined by IFCAP_* below. 202 * struct ifnet.if_capenable 203 * contains the enabled (either by default or through ifconfig) optional 204 * features & capabilities on this interface. 205 * Capabilities are defined by IFCAP_* below. 206 * struct if_data.ifi_hwassist in mbuf CSUM_ flag form, controlled by above 207 * contains the enabled optional feature & capabilites that can be used 208 * individually per packet and are specified in the mbuf pkthdr.csum_flags 209 * field. IFCAP_* and CSUM_* do not match one to one and CSUM_* may be 210 * more detailed or differentiated than IFCAP_*. 211 * Hwassist features are defined CSUM_* in sys/mbuf.h 212 * 213 * Capabilities that cannot be arbitrarily changed with ifconfig/ioctl 214 * are listed in IFCAP_CANTCHANGE, similar to IFF_CANTCHANGE. 215 * This is not strictly necessary because the common code never 216 * changes capabilities, and it is left to the individual driver 217 * to do the right thing. However, having the filter here 218 * avoids replication of the same code in all individual drivers. 219 */ 220 221 /* IFCAP values as bit indexes */ 222 223 #define IFCAP_B_RXCSUM 0 /* can offload checksum on RX */ 224 #define IFCAP_B_TXCSUM 1 /* can offload checksum on TX */ 225 #define IFCAP_B_NETCONS 2 /* can be a network console */ 226 #define IFCAP_B_VLAN_MTU 3 /* VLAN-compatible MTU */ 227 #define IFCAP_B_VLAN_HWTAGGING 4 /* hardware VLAN tag support */ 228 #define IFCAP_B_JUMBO_MTU 5 /* 9000 byte MTU supported */ 229 #define IFCAP_B_POLLING 6 /* driver supports polling */ 230 #define IFCAP_B_VLAN_HWCSUM 7 /* can do IFCAP_HWCSUM on VLANs */ 231 #define IFCAP_B_TSO4 8 /* can do TCP Segmentation Offload */ 232 #define IFCAP_B_TSO6 9 /* can do TCP6 Segmentation Offload */ 233 #define IFCAP_B_LRO 10 /* can do Large Receive Offload */ 234 #define IFCAP_B_WOL_UCAST 11 /* wake on any unicast frame */ 235 #define IFCAP_B_WOL_MCAST 12 /* wake on any multicast frame */ 236 #define IFCAP_B_WOL_MAGIC 13 /* wake on any Magic Packet */ 237 #define IFCAP_B_TOE4 14 /* interface can offload TCP */ 238 #define IFCAP_B_TOE6 15 /* interface can offload TCP6 */ 239 #define IFCAP_B_VLAN_HWFILTER 16 /* interface hw can filter vlan tag */ 240 #define IFCAP_B_NV 17 /* can do SIOCGIFCAPNV/SIOCSIFCAPNV */ 241 #define IFCAP_B_VLAN_HWTSO 18 /* can do IFCAP_TSO on VLANs */ 242 #define IFCAP_B_LINKSTATE 19 /* the runtime link state is dynamic */ 243 #define IFCAP_B_NETMAP 20 /* netmap mode supported/enabled */ 244 #define IFCAP_B_RXCSUM_IPV6 21 /* can offload checksum on IPv6 RX */ 245 #define IFCAP_B_TXCSUM_IPV6 22 /* can offload checksum on IPv6 TX */ 246 #define IFCAP_B_HWSTATS 23 /* manages counters internally */ 247 #define IFCAP_B_TXRTLMT 24 /* hardware supports TX rate limiting */ 248 #define IFCAP_B_HWRXTSTMP 25 /* hardware rx timestamping */ 249 #define IFCAP_B_MEXTPG 26 /* understands M_EXTPG mbufs */ 250 #define IFCAP_B_TXTLS4 27 /* can do TLS encryption and segmentation for TCP */ 251 #define IFCAP_B_TXTLS6 28 /* can do TLS encryption and segmentation for TCP6 */ 252 #define IFCAP_B_VXLAN_HWCSUM 29 /* can do IFCAN_HWCSUM on VXLANs */ 253 #define IFCAP_B_VXLAN_HWTSO 30 /* can do IFCAP_TSO on VXLANs */ 254 #define IFCAP_B_TXTLS_RTLMT 31 /* can do TLS with rate limiting */ 255 #define IFCAP_B_RXTLS4 32 /* can do TLS receive for TCP */ 256 #define IFCAP_B_RXTLS6 33 /* can do TLS receive for TCP6 */ 257 #define IFCAP_B_IPSEC_OFFLOAD 34 /* inline IPSEC offload */ 258 #define IFCAP_B_GENEVE_HWCSUM 35 /* can do IFCAN_HWCSUM on GENEVE */ 259 #define IFCAP_B_GENEVE_HWTSO 36 /* can do IFCAP_TSO on GENEVE */ 260 #define __IFCAP_B_SIZE 37 261 262 #define IFCAP_B_MAX (__IFCAP_B_MAX - 1) 263 #define IFCAP_B_SIZE (__IFCAP_B_SIZE) 264 265 #define IFCAP_BIT(x) (1 << (x)) 266 267 #define IFCAP_RXCSUM IFCAP_BIT(IFCAP_B_RXCSUM) 268 #define IFCAP_TXCSUM IFCAP_BIT(IFCAP_B_TXCSUM) 269 #define IFCAP_NETCONS IFCAP_BIT(IFCAP_B_NETCONS) 270 #define IFCAP_VLAN_MTU IFCAP_BIT(IFCAP_B_VLAN_MTU) 271 #define IFCAP_VLAN_HWTAGGING IFCAP_BIT(IFCAP_B_VLAN_HWTAGGING) 272 #define IFCAP_JUMBO_MTU IFCAP_BIT(IFCAP_B_JUMBO_MTU) 273 #define IFCAP_POLLING IFCAP_BIT(IFCAP_B_POLLING) 274 #define IFCAP_VLAN_HWCSUM IFCAP_BIT(IFCAP_B_VLAN_HWCSUM) 275 #define IFCAP_TSO4 IFCAP_BIT(IFCAP_B_TSO4) 276 #define IFCAP_TSO6 IFCAP_BIT(IFCAP_B_TSO6) 277 #define IFCAP_LRO IFCAP_BIT(IFCAP_B_LRO) 278 #define IFCAP_WOL_UCAST IFCAP_BIT(IFCAP_B_WOL_UCAST) 279 #define IFCAP_WOL_MCAST IFCAP_BIT(IFCAP_B_WOL_MCAST) 280 #define IFCAP_WOL_MAGIC IFCAP_BIT(IFCAP_B_WOL_MAGIC) 281 #define IFCAP_TOE4 IFCAP_BIT(IFCAP_B_TOE4) 282 #define IFCAP_TOE6 IFCAP_BIT(IFCAP_B_TOE6) 283 #define IFCAP_VLAN_HWFILTER IFCAP_BIT(IFCAP_B_VLAN_HWFILTER) 284 #define IFCAP_NV IFCAP_BIT(IFCAP_B_NV) 285 #define IFCAP_VLAN_HWTSO IFCAP_BIT(IFCAP_B_VLAN_HWTSO) 286 #define IFCAP_LINKSTATE IFCAP_BIT(IFCAP_B_LINKSTATE) 287 #define IFCAP_NETMAP IFCAP_BIT(IFCAP_B_NETMAP) 288 #define IFCAP_RXCSUM_IPV6 IFCAP_BIT(IFCAP_B_RXCSUM_IPV6) 289 #define IFCAP_TXCSUM_IPV6 IFCAP_BIT(IFCAP_B_TXCSUM_IPV6) 290 #define IFCAP_HWSTATS IFCAP_BIT(IFCAP_B_HWSTATS) 291 #define IFCAP_TXRTLMT IFCAP_BIT(IFCAP_B_TXRTLMT) 292 #define IFCAP_HWRXTSTMP IFCAP_BIT(IFCAP_B_HWRXTSTMP) 293 #define IFCAP_MEXTPG IFCAP_BIT(IFCAP_B_MEXTPG) 294 #define IFCAP_TXTLS4 IFCAP_BIT(IFCAP_B_TXTLS4) 295 #define IFCAP_TXTLS6 IFCAP_BIT(IFCAP_B_TXTLS6) 296 #define IFCAP_VXLAN_HWCSUM IFCAP_BIT(IFCAP_B_VXLAN_HWCSUM) 297 #define IFCAP_VXLAN_HWTSO IFCAP_BIT(IFCAP_B_VXLAN_HWTSO) 298 #define IFCAP_TXTLS_RTLMT IFCAP_BIT(IFCAP_B_TXTLS_RTLMT) 299 300 /* IFCAP2_* are integers, not bits. */ 301 #define IFCAP2_RXTLS4 (IFCAP_B_RXTLS4 - 32) 302 #define IFCAP2_RXTLS6 (IFCAP_B_RXTLS6 - 32) 303 #define IFCAP2_IPSEC_OFFLOAD (IFCAP_B_IPSEC_OFFLOAD - 32) 304 #define IFCAP2_GENEVE_HWCSUM (IFCAP_B_GENEVE_HWCSUM - 32) 305 #define IFCAP2_GENEVE_HWTSO (IFCAP_B_GENEVE_HWTSO - 32) 306 307 #define IFCAP2_BIT(x) (1UL << (x)) 308 309 #define IFCAP_HWCSUM_IPV6 (IFCAP_RXCSUM_IPV6 | IFCAP_TXCSUM_IPV6) 310 311 #define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM) 312 #define IFCAP_TSO (IFCAP_TSO4 | IFCAP_TSO6) 313 #define IFCAP_WOL (IFCAP_WOL_UCAST | IFCAP_WOL_MCAST | IFCAP_WOL_MAGIC) 314 #define IFCAP_TOE (IFCAP_TOE4 | IFCAP_TOE6) 315 #define IFCAP_TXTLS (IFCAP_TXTLS4 | IFCAP_TXTLS6) 316 317 #define IFCAP_CANTCHANGE (IFCAP_NETMAP | IFCAP_NV) 318 #define IFCAP_ALLCAPS 0xffffffff 319 320 #define IFQ_MAXLEN 50 321 #define IFNET_SLOWHZ 1 /* granularity is 1 second */ 322 323 /* 324 * Message format for use in obtaining information about interfaces 325 * from getkerninfo and the routing socket 326 * For the new, extensible interface see struct if_msghdrl below. 327 */ 328 struct if_msghdr { 329 u_short ifm_msglen; /* to skip over non-understood messages */ 330 u_char ifm_version; /* future binary compatibility */ 331 u_char ifm_type; /* message type */ 332 int ifm_addrs; /* like rtm_addrs */ 333 int ifm_flags; /* value of if_flags */ 334 u_short ifm_index; /* index for associated ifp */ 335 u_short _ifm_spare1; 336 struct if_data ifm_data;/* statistics and other data about if */ 337 }; 338 339 /* 340 * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL. It is 341 * extensible after ifm_data_off or within ifm_data. Both the if_msghdr and 342 * if_data now have a member field detailing the struct length in addition to 343 * the routing message length. Macros are provided to find the start of 344 * ifm_data and the start of the socket address structures immediately following 345 * struct if_msghdrl given a pointer to struct if_msghdrl. 346 */ 347 #define IF_MSGHDRL_IFM_DATA(_l) \ 348 (struct if_data *)((char *)(_l) + (_l)->ifm_data_off) 349 #define IF_MSGHDRL_RTA(_l) \ 350 (void *)((uintptr_t)(_l) + (_l)->ifm_len) 351 struct if_msghdrl { 352 u_short ifm_msglen; /* to skip over non-understood messages */ 353 u_char ifm_version; /* future binary compatibility */ 354 u_char ifm_type; /* message type */ 355 int ifm_addrs; /* like rtm_addrs */ 356 int ifm_flags; /* value of if_flags */ 357 u_short ifm_index; /* index for associated ifp */ 358 u_short _ifm_spare1; /* spare space to grow if_index, see if_var.h */ 359 u_short ifm_len; /* length of if_msghdrl incl. if_data */ 360 u_short ifm_data_off; /* offset of if_data from beginning */ 361 int _ifm_spare2; 362 struct if_data ifm_data;/* statistics and other data about if */ 363 }; 364 365 /* 366 * Message format for use in obtaining information about interface addresses 367 * from getkerninfo and the routing socket 368 * For the new, extensible interface see struct ifa_msghdrl below. 369 */ 370 struct ifa_msghdr { 371 u_short ifam_msglen; /* to skip over non-understood messages */ 372 u_char ifam_version; /* future binary compatibility */ 373 u_char ifam_type; /* message type */ 374 int ifam_addrs; /* like rtm_addrs */ 375 int ifam_flags; /* value of ifa_flags */ 376 u_short ifam_index; /* index for associated ifp */ 377 u_short _ifam_spare1; 378 int ifam_metric; /* value of ifa_ifp->if_metric */ 379 }; 380 381 /* 382 * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL. It is 383 * extensible after ifam_metric or within ifam_data. Both the ifa_msghdrl and 384 * if_data now have a member field detailing the struct length in addition to 385 * the routing message length. Macros are provided to find the start of 386 * ifm_data and the start of the socket address structures immediately following 387 * struct ifa_msghdrl given a pointer to struct ifa_msghdrl. 388 */ 389 #define IFA_MSGHDRL_IFAM_DATA(_l) \ 390 (struct if_data *)((char *)(_l) + (_l)->ifam_data_off) 391 #define IFA_MSGHDRL_RTA(_l) \ 392 (void *)((uintptr_t)(_l) + (_l)->ifam_len) 393 struct ifa_msghdrl { 394 u_short ifam_msglen; /* to skip over non-understood messages */ 395 u_char ifam_version; /* future binary compatibility */ 396 u_char ifam_type; /* message type */ 397 int ifam_addrs; /* like rtm_addrs */ 398 int ifam_flags; /* value of ifa_flags */ 399 u_short ifam_index; /* index for associated ifp */ 400 u_short _ifam_spare1; /* spare space to grow if_index, see if_var.h */ 401 u_short ifam_len; /* length of ifa_msghdrl incl. if_data */ 402 u_short ifam_data_off; /* offset of if_data from beginning */ 403 int ifam_metric; /* value of ifa_ifp->if_metric */ 404 struct if_data ifam_data;/* statistics and other data about if or 405 * address */ 406 }; 407 408 /* 409 * Message format for use in obtaining information about multicast addresses 410 * from the routing socket 411 */ 412 struct ifma_msghdr { 413 u_short ifmam_msglen; /* to skip over non-understood messages */ 414 u_char ifmam_version; /* future binary compatibility */ 415 u_char ifmam_type; /* message type */ 416 int ifmam_addrs; /* like rtm_addrs */ 417 int ifmam_flags; /* value of ifa_flags */ 418 u_short ifmam_index; /* index for associated ifp */ 419 u_short _ifmam_spare1; 420 }; 421 422 /* 423 * Message format announcing the arrival or departure of a network interface. 424 */ 425 struct if_announcemsghdr { 426 u_short ifan_msglen; /* to skip over non-understood messages */ 427 u_char ifan_version; /* future binary compatibility */ 428 u_char ifan_type; /* message type */ 429 u_short ifan_index; /* index for associated ifp */ 430 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 431 u_short ifan_what; /* what type of announcement */ 432 }; 433 434 #define IFAN_ARRIVAL 0 /* interface arrival */ 435 #define IFAN_DEPARTURE 1 /* interface departure */ 436 437 /* 438 * Buffer with length to be used in SIOCGIFDESCR/SIOCSIFDESCR requests 439 */ 440 struct ifreq_buffer { 441 size_t length; 442 void *buffer; 443 }; 444 445 struct ifreq_nv_req { 446 u_int buf_length; /* Total size of buffer, 447 u_int for ABI struct ifreq */ 448 u_int length; /* Length of the filled part */ 449 void *buffer; /* Buffer itself, containing packed nv */ 450 }; 451 452 #define IFR_CAP_NV_MAXBUFSIZE (2 * 1024 * 1024) 453 454 /* 455 * Interface request structure used for socket 456 * ioctl's. All interface ioctl's must have parameter 457 * definitions which begin with ifr_name. The 458 * remainder may be interface specific. 459 */ 460 struct ifreq { 461 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 462 union { 463 struct sockaddr ifru_addr; 464 struct sockaddr ifru_dstaddr; 465 struct sockaddr ifru_broadaddr; 466 struct ifreq_buffer ifru_buffer; 467 short ifru_flags[2]; 468 short ifru_index; 469 int ifru_jid; 470 int ifru_metric; 471 int ifru_mtu; 472 int ifru_phys; 473 int ifru_media; 474 caddr_t ifru_data; 475 int ifru_cap[2]; 476 u_int ifru_fib; 477 u_char ifru_vlan_pcp; 478 struct ifreq_nv_req ifru_nv; 479 } ifr_ifru; 480 #define ifr_addr ifr_ifru.ifru_addr /* address */ 481 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 482 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 483 #ifndef _KERNEL 484 #define ifr_buffer ifr_ifru.ifru_buffer /* user supplied buffer with its length */ 485 #endif 486 #define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */ 487 #define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */ 488 #define ifr_jid ifr_ifru.ifru_jid /* jail/vnet */ 489 #define ifr_metric ifr_ifru.ifru_metric /* metric */ 490 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 491 #define ifr_phys ifr_ifru.ifru_phys /* physical wire */ 492 #define ifr_media ifr_ifru.ifru_media /* physical media */ 493 #ifndef _KERNEL 494 #define ifr_data ifr_ifru.ifru_data /* for use by interface */ 495 #endif 496 #define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */ 497 #define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */ 498 #define ifr_index ifr_ifru.ifru_index /* interface index */ 499 #define ifr_fib ifr_ifru.ifru_fib /* interface fib */ 500 #define ifr_vlan_pcp ifr_ifru.ifru_vlan_pcp /* VLAN priority */ 501 #define ifr_lan_pcp ifr_ifru.ifru_vlan_pcp /* VLAN priority */ 502 #define ifr_cap_nv ifr_ifru.ifru_nv /* nv-based cap interface */ 503 }; 504 505 #define _SIZEOF_ADDR_IFREQ(ifr) \ 506 ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \ 507 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \ 508 (ifr).ifr_addr.sa_len) : sizeof(struct ifreq)) 509 510 struct ifaliasreq { 511 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 512 struct sockaddr ifra_addr; 513 struct sockaddr ifra_broadaddr; 514 struct sockaddr ifra_mask; 515 int ifra_vhid; 516 }; 517 518 /* 9.x compat */ 519 struct oifaliasreq { 520 char ifra_name[IFNAMSIZ]; 521 struct sockaddr ifra_addr; 522 struct sockaddr ifra_broadaddr; 523 struct sockaddr ifra_mask; 524 }; 525 526 struct ifmediareq { 527 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 528 int ifm_current; /* current media options */ 529 int ifm_mask; /* don't care mask */ 530 int ifm_status; /* media status */ 531 int ifm_active; /* active options */ 532 int ifm_count; /* # entries in ifm_ulist array */ 533 int *ifm_ulist; /* media words */ 534 }; 535 536 struct ifdrv { 537 char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 538 unsigned long ifd_cmd; 539 size_t ifd_len; 540 void *ifd_data; 541 }; 542 543 /* 544 * Structure used to retrieve aux status data from interfaces. 545 * Kernel suppliers to this interface should respect the formatting 546 * needed by ifconfig(8): each line starts with a TAB and ends with 547 * a newline. The canonical example to copy and paste is in if_tun.c. 548 */ 549 550 #define IFSTATMAX 800 /* 10 lines of text */ 551 struct ifstat { 552 char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 553 char ascii[IFSTATMAX + 1]; 554 }; 555 556 /* 557 * Structure used in SIOCGIFCONF request. 558 * Used to retrieve interface configuration 559 * for machine (useful for programs which 560 * must know all networks accessible). 561 */ 562 struct ifconf { 563 int ifc_len; /* size of associated buffer */ 564 union { 565 caddr_t ifcu_buf; 566 struct ifreq *ifcu_req; 567 } ifc_ifcu; 568 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 569 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 570 }; 571 572 /* 573 * interface groups 574 */ 575 576 #define IFG_ALL "all" /* group contains all interfaces */ 577 /* XXX: will we implement this? */ 578 #define IFG_EGRESS "egress" /* if(s) default route(s) point to */ 579 580 struct ifg_req { 581 union { 582 char ifgrqu_group[IFNAMSIZ]; 583 char ifgrqu_member[IFNAMSIZ]; 584 } ifgrq_ifgrqu; 585 #define ifgrq_group ifgrq_ifgrqu.ifgrqu_group 586 #define ifgrq_member ifgrq_ifgrqu.ifgrqu_member 587 }; 588 589 /* 590 * Used to lookup groups for an interface 591 */ 592 struct ifgroupreq { 593 char ifgr_name[IFNAMSIZ]; 594 u_int ifgr_len; 595 union { 596 char ifgru_group[IFNAMSIZ]; 597 struct ifg_req *ifgru_groups; 598 } ifgr_ifgru; 599 #define ifgr_group ifgr_ifgru.ifgru_group 600 #define ifgr_groups ifgr_ifgru.ifgru_groups 601 }; 602 603 /* 604 * Structure used to request i2c data 605 * from interface transceivers. 606 */ 607 struct ifi2creq { 608 uint8_t dev_addr; /* i2c address (0xA0, 0xA2) */ 609 uint8_t offset; /* read offset */ 610 uint8_t len; /* read length */ 611 uint8_t page; /* CMIS page number (0 for legacy) */ 612 uint8_t bank; /* CMIS bank number (0 for legacy) */ 613 uint8_t spare[3]; /* reserved for future use */ 614 uint8_t data[8]; /* read buffer */ 615 }; 616 617 /* 618 * RSS hash. 619 */ 620 621 #define RSS_FUNC_NONE 0 /* RSS disabled */ 622 #define RSS_FUNC_PRIVATE 1 /* non-standard */ 623 #define RSS_FUNC_TOEPLITZ 2 624 625 #define RSS_TYPE_IPV4 0x00000001 626 #define RSS_TYPE_TCP_IPV4 0x00000002 627 #define RSS_TYPE_IPV6 0x00000004 628 #define RSS_TYPE_IPV6_EX 0x00000008 629 #define RSS_TYPE_TCP_IPV6 0x00000010 630 #define RSS_TYPE_TCP_IPV6_EX 0x00000020 631 #define RSS_TYPE_UDP_IPV4 0x00000040 632 #define RSS_TYPE_UDP_IPV6 0x00000080 633 #define RSS_TYPE_UDP_IPV6_EX 0x00000100 634 635 #define RSS_KEYLEN 128 636 637 struct ifrsskey { 638 char ifrk_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 639 uint8_t ifrk_func; /* RSS_FUNC_ */ 640 uint8_t ifrk_spare0; 641 uint16_t ifrk_keylen; 642 uint8_t ifrk_key[RSS_KEYLEN]; 643 }; 644 645 struct ifrsshash { 646 char ifrh_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 647 uint8_t ifrh_func; /* RSS_FUNC_ */ 648 uint8_t ifrh_spare0; 649 uint16_t ifrh_spare1; 650 uint32_t ifrh_types; /* RSS_TYPE_ */ 651 }; 652 653 #define IFNET_PCP_NONE 0xff /* PCP disabled */ 654 655 #define IFDR_MSG_SIZE 64 656 #define IFDR_REASON_MSG 1 657 #define IFDR_REASON_VENDOR 2 658 struct ifdownreason { 659 char ifdr_name[IFNAMSIZ]; 660 uint32_t ifdr_reason; 661 uint32_t ifdr_vendor; 662 char ifdr_msg[IFDR_MSG_SIZE]; 663 }; 664 665 #endif /* __BSD_VISIBLE */ 666 667 /* 668 * Opaque interface structure. 669 */ 670 671 typedef struct ifnet *if_t; 672 673 #ifdef _KERNEL 674 #ifdef MALLOC_DECLARE 675 MALLOC_DECLARE(M_IFADDR); 676 MALLOC_DECLARE(M_IFMADDR); 677 #endif 678 679 extern struct sx ifnet_detach_sxlock; 680 681 struct nvlist; 682 struct ifcap_nv_bit_name; 683 int if_capnv_to_capint(const struct nvlist *nv, int *old_cap, 684 const struct ifcap_nv_bit_name *nn, bool all); 685 void if_capint_to_capnv(struct nvlist *nv, 686 const struct ifcap_nv_bit_name *nn, int ifr_cap, int ifr_req); 687 struct siocsifcapnv_driver_data { 688 int reqcap; 689 int reqcap2; 690 struct nvlist *nvcap; 691 }; 692 #endif 693 694 #ifndef _KERNEL 695 struct if_nameindex { 696 unsigned int if_index; /* 1, 2, ... */ 697 char *if_name; /* null terminated name: "le0", ... */ 698 }; 699 700 __BEGIN_DECLS 701 void if_freenameindex(struct if_nameindex *); 702 char *if_indextoname(unsigned int, char *); 703 struct if_nameindex *if_nameindex(void); 704 unsigned int if_nametoindex(const char *); 705 __END_DECLS 706 #endif 707 #endif /* !_NET_IF_H_ */ 708