2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1982, 1986, 1989, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
31 * @(#)if.h 8.1 (Berkeley) 6/10/93
38 #include <sys/cdefs.h>
42 * <net/if.h> does not depend on <sys/time.h> on most other systems. This
43 * helps userland compatibility. (struct timeval ifi_lastchange)
44 * The same holds for <sys/socket.h>. (struct sockaddr ifru_addr)
48 #include <sys/socket.h>
53 * Length of interface external name, including terminating '\0'.
54 * Note: this is the same size as a generic device's external name.
56 #define IF_NAMESIZE 16
58 #define IFNAMSIZ IF_NAMESIZE
59 #define IF_MAXUNIT 0x7fff /* historical value */
64 * Structure used to query names of interface cloners.
68 int ifcr_total; /* total cloners (out) */
69 int ifcr_count; /* room for this many in user buffer */
70 char *ifcr_buffer; /* buffer for cloner names */
74 * Structure describing information about an interface
75 * which may be of interest to management entities.
78 /* generic interface information */
79 uint8_t ifi_type; /* ethernet, tokenring, etc */
80 uint8_t ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */
81 uint8_t ifi_addrlen; /* media address length */
82 uint8_t ifi_hdrlen; /* media header length */
83 uint8_t ifi_link_state; /* current link state */
84 uint8_t ifi_vhid; /* carp vhid */
85 uint16_t ifi_datalen; /* length of this data struct */
86 uint32_t ifi_mtu; /* maximum transmission unit */
87 uint32_t ifi_metric; /* routing metric (external only) */
88 uint64_t ifi_baudrate; /* linespeed */
89 /* volatile statistics */
90 uint64_t ifi_ipackets; /* packets received on interface */
91 uint64_t ifi_ierrors; /* input errors on interface */
92 uint64_t ifi_opackets; /* packets sent on interface */
93 uint64_t ifi_oerrors; /* output errors on interface */
94 uint64_t ifi_collisions; /* collisions on csma interfaces */
95 uint64_t ifi_ibytes; /* total number of octets received */
96 uint64_t ifi_obytes; /* total number of octets sent */
97 uint64_t ifi_imcasts; /* packets received via multicast */
98 uint64_t ifi_omcasts; /* packets sent via multicast */
99 uint64_t ifi_iqdrops; /* dropped on input */
100 uint64_t ifi_oqdrops; /* dropped on output */
101 uint64_t ifi_noproto; /* destined for unsupported protocol */
102 uint64_t ifi_hwassist; /* HW offload capabilities, see IFCAP */
104 /* Unions are here to make sizes MI. */
105 union { /* uptime at attach or stat reset */
109 #define ifi_epoch __ifi_epoch.tt
110 union { /* time of last administrative change */
117 #define ifi_lastchange __ifi_lastchange.tv
121 * Interface flags are of two types: network stack owned flags, and driver
122 * owned flags. Historically, these values were stored in the same ifnet
123 * flags field, but with the advent of fine-grained locking, they have been
124 * broken out such that the network stack is responsible for synchronizing
125 * the stack-owned fields, and the device driver the device-owned fields.
126 * Both halves can perform lockless reads of the other half's field, subject
127 * to accepting the involved races.
129 * Both sets of flags come from the same number space, and should not be
130 * permitted to conflict, as they are exposed to user space via a single
133 * The following symbols identify read and write requirements for fields:
135 * (i) if_flags field set by device driver before attach, read-only there
137 * (n) if_flags field written only by the network stack, read by either the
139 * (d) if_drv_flags field written only by the device driver, read by either
140 * the stack or driver.
142 #define IFF_UP 0x1 /* (n) interface is up */
143 #define IFF_BROADCAST 0x2 /* (i) broadcast address valid */
144 #define IFF_DEBUG 0x4 /* (n) turn on debugging */
145 #define IFF_LOOPBACK 0x8 /* (i) is a loopback net */
146 #define IFF_POINTOPOINT 0x10 /* (i) is a point-to-point link */
147 /* 0x20 was IFF_SMART */
148 #define IFF_DRV_RUNNING 0x40 /* (d) resources allocated */
149 #define IFF_NOARP 0x80 /* (n) no address resolution protocol */
150 #define IFF_PROMISC 0x100 /* (n) receive all packets */
151 #define IFF_ALLMULTI 0x200 /* (n) receive all multicast packets */
152 #define IFF_DRV_OACTIVE 0x400 /* (d) tx hardware queue is full */
153 #define IFF_SIMPLEX 0x800 /* (i) can't hear own transmissions */
154 #define IFF_LINK0 0x1000 /* per link layer defined bit */
155 #define IFF_LINK1 0x2000 /* per link layer defined bit */
156 #define IFF_LINK2 0x4000 /* per link layer defined bit */
157 #define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */
158 #define IFF_MULTICAST 0x8000 /* (i) supports multicast */
159 #define IFF_CANTCONFIG 0x10000 /* (i) unconfigurable using ioctl(2) */
160 #define IFF_PPROMISC 0x20000 /* (n) user-requested promisc mode */
161 #define IFF_MONITOR 0x40000 /* (n) user-requested monitor mode */
162 #define IFF_STATICARP 0x80000 /* (n) static ARP */
163 #define IFF_DYING 0x200000 /* (n) interface is winding down */
164 #define IFF_RENAMING 0x400000 /* (n) interface is being renamed */
166 * Old names for driver flags so that user space tools can continue to use
167 * the old (portable) names.
170 #define IFF_RUNNING IFF_DRV_RUNNING
171 #define IFF_OACTIVE IFF_DRV_OACTIVE
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)
181 * Values for if_link_state.
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 */
188 * Some convenience macros used for setting ifi_baudrate.
189 * XXX 1000 vs. 1024? --thorpej@netbsd.org
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. */
196 * Capabilities that interfaces can advertise.
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 differenciated than IFCAP_*.
211 * Hwassist features are defined CSUM_* in sys/mbuf.h
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.
220 #define IFCAP_RXCSUM 0x00001 /* can offload checksum on RX */
221 #define IFCAP_TXCSUM 0x00002 /* can offload checksum on TX */
222 #define IFCAP_NETCONS 0x00004 /* can be a network console */
223 #define IFCAP_VLAN_MTU 0x00008 /* VLAN-compatible MTU */
224 #define IFCAP_VLAN_HWTAGGING 0x00010 /* hardware VLAN tag support */
225 #define IFCAP_JUMBO_MTU 0x00020 /* 9000 byte MTU supported */
226 #define IFCAP_POLLING 0x00040 /* driver supports polling */
227 #define IFCAP_VLAN_HWCSUM 0x00080 /* can do IFCAP_HWCSUM on VLANs */
228 #define IFCAP_TSO4 0x00100 /* can do TCP Segmentation Offload */
229 #define IFCAP_TSO6 0x00200 /* can do TCP6 Segmentation Offload */
230 #define IFCAP_LRO 0x00400 /* can do Large Receive Offload */
231 #define IFCAP_WOL_UCAST 0x00800 /* wake on any unicast frame */
232 #define IFCAP_WOL_MCAST 0x01000 /* wake on any multicast frame */
233 #define IFCAP_WOL_MAGIC 0x02000 /* wake on any Magic Packet */
234 #define IFCAP_TOE4 0x04000 /* interface can offload TCP */
235 #define IFCAP_TOE6 0x08000 /* interface can offload TCP6 */
236 #define IFCAP_VLAN_HWFILTER 0x10000 /* interface hw can filter vlan tag */
237 /* available 0x20000 */
238 #define IFCAP_VLAN_HWTSO 0x40000 /* can do IFCAP_TSO on VLANs */
239 #define IFCAP_LINKSTATE 0x80000 /* the runtime link state is dynamic */
240 #define IFCAP_NETMAP 0x100000 /* netmap mode supported/enabled */
241 #define IFCAP_RXCSUM_IPV6 0x200000 /* can offload checksum on IPv6 RX */
242 #define IFCAP_TXCSUM_IPV6 0x400000 /* can offload checksum on IPv6 TX */
243 #define IFCAP_HWSTATS 0x800000 /* manages counters internally */
244 #define IFCAP_TXRTLMT 0x1000000 /* hardware supports TX rate limiting */
245 #define IFCAP_HWRXTSTMP 0x2000000 /* hardware rx timestamping */
247 #define IFCAP_HWCSUM_IPV6 (IFCAP_RXCSUM_IPV6 | IFCAP_TXCSUM_IPV6)
249 #define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM)
250 #define IFCAP_TSO (IFCAP_TSO4 | IFCAP_TSO6)
251 #define IFCAP_WOL (IFCAP_WOL_UCAST | IFCAP_WOL_MCAST | IFCAP_WOL_MAGIC)
252 #define IFCAP_TOE (IFCAP_TOE4 | IFCAP_TOE6)
254 #define IFCAP_CANTCHANGE (IFCAP_NETMAP)
256 #define IFQ_MAXLEN 50
257 #define IFNET_SLOWHZ 1 /* granularity is 1 second */
260 * Message format for use in obtaining information about interfaces
261 * from getkerninfo and the routing socket
262 * For the new, extensible interface see struct if_msghdrl below.
265 u_short ifm_msglen; /* to skip over non-understood messages */
266 u_char ifm_version; /* future binary compatibility */
267 u_char ifm_type; /* message type */
268 int ifm_addrs; /* like rtm_addrs */
269 int ifm_flags; /* value of if_flags */
270 u_short ifm_index; /* index for associated ifp */
271 struct if_data ifm_data;/* statistics and other data about if */
275 * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL. It is
276 * extensible after ifm_data_off or within ifm_data. Both the if_msghdr and
277 * if_data now have a member field detailing the struct length in addition to
278 * the routing message length. Macros are provided to find the start of
279 * ifm_data and the start of the socket address strucutres immediately following
280 * struct if_msghdrl given a pointer to struct if_msghdrl.
282 #define IF_MSGHDRL_IFM_DATA(_l) \
283 (struct if_data *)((char *)(_l) + (_l)->ifm_data_off)
284 #define IF_MSGHDRL_RTA(_l) \
285 (void *)((uintptr_t)(_l) + (_l)->ifm_len)
287 u_short ifm_msglen; /* to skip over non-understood messages */
288 u_char ifm_version; /* future binary compatibility */
289 u_char ifm_type; /* message type */
290 int ifm_addrs; /* like rtm_addrs */
291 int ifm_flags; /* value of if_flags */
292 u_short ifm_index; /* index for associated ifp */
293 u_short _ifm_spare1; /* spare space to grow if_index, see if_var.h */
294 u_short ifm_len; /* length of if_msghdrl incl. if_data */
295 u_short ifm_data_off; /* offset of if_data from beginning */
296 struct if_data ifm_data;/* statistics and other data about if */
300 * Message format for use in obtaining information about interface addresses
301 * from getkerninfo and the routing socket
302 * For the new, extensible interface see struct ifa_msghdrl below.
305 u_short ifam_msglen; /* to skip over non-understood messages */
306 u_char ifam_version; /* future binary compatibility */
307 u_char ifam_type; /* message type */
308 int ifam_addrs; /* like rtm_addrs */
309 int ifam_flags; /* value of ifa_flags */
310 u_short ifam_index; /* index for associated ifp */
311 int ifam_metric; /* value of ifa_ifp->if_metric */
315 * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL. It is
316 * extensible after ifam_metric or within ifam_data. Both the ifa_msghdrl and
317 * if_data now have a member field detailing the struct length in addition to
318 * the routing message length. Macros are provided to find the start of
319 * ifm_data and the start of the socket address strucutres immediately following
320 * struct ifa_msghdrl given a pointer to struct ifa_msghdrl.
322 #define IFA_MSGHDRL_IFAM_DATA(_l) \
323 (struct if_data *)((char *)(_l) + (_l)->ifam_data_off)
324 #define IFA_MSGHDRL_RTA(_l) \
325 (void *)((uintptr_t)(_l) + (_l)->ifam_len)
327 u_short ifam_msglen; /* to skip over non-understood messages */
328 u_char ifam_version; /* future binary compatibility */
329 u_char ifam_type; /* message type */
330 int ifam_addrs; /* like rtm_addrs */
331 int ifam_flags; /* value of ifa_flags */
332 u_short ifam_index; /* index for associated ifp */
333 u_short _ifam_spare1; /* spare space to grow if_index, see if_var.h */
334 u_short ifam_len; /* length of ifa_msghdrl incl. if_data */
335 u_short ifam_data_off; /* offset of if_data from beginning */
336 int ifam_metric; /* value of ifa_ifp->if_metric */
337 struct if_data ifam_data;/* statistics and other data about if or
342 * Message format for use in obtaining information about multicast addresses
343 * from the routing socket
346 u_short ifmam_msglen; /* to skip over non-understood messages */
347 u_char ifmam_version; /* future binary compatibility */
348 u_char ifmam_type; /* message type */
349 int ifmam_addrs; /* like rtm_addrs */
350 int ifmam_flags; /* value of ifa_flags */
351 u_short ifmam_index; /* index for associated ifp */
355 * Message format announcing the arrival or departure of a network interface.
357 struct if_announcemsghdr {
358 u_short ifan_msglen; /* to skip over non-understood messages */
359 u_char ifan_version; /* future binary compatibility */
360 u_char ifan_type; /* message type */
361 u_short ifan_index; /* index for associated ifp */
362 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
363 u_short ifan_what; /* what type of announcement */
366 #define IFAN_ARRIVAL 0 /* interface arrival */
367 #define IFAN_DEPARTURE 1 /* interface departure */
370 * Buffer with length to be used in SIOCGIFDESCR/SIOCSIFDESCR requests
372 struct ifreq_buffer {
378 * Interface request structure used for socket
379 * ioctl's. All interface ioctl's must have parameter
380 * definitions which begin with ifr_name. The
381 * remainder may be interface specific.
384 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */
386 struct sockaddr ifru_addr;
387 struct sockaddr ifru_dstaddr;
388 struct sockaddr ifru_broadaddr;
389 struct ifreq_buffer ifru_buffer;
400 u_char ifru_vlan_pcp;
402 #define ifr_addr ifr_ifru.ifru_addr /* address */
403 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */
404 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
405 #define ifr_buffer ifr_ifru.ifru_buffer /* user supplied buffer with its length */
406 #define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */
407 #define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */
408 #define ifr_jid ifr_ifru.ifru_jid /* jail/vnet */
409 #define ifr_metric ifr_ifru.ifru_metric /* metric */
410 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
411 #define ifr_phys ifr_ifru.ifru_phys /* physical wire */
412 #define ifr_media ifr_ifru.ifru_media /* physical media */
413 #define ifr_data ifr_ifru.ifru_data /* for use by interface */
414 #define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */
415 #define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */
416 #define ifr_index ifr_ifru.ifru_index /* interface index */
417 #define ifr_fib ifr_ifru.ifru_fib /* interface fib */
418 #define ifr_vlan_pcp ifr_ifru.ifru_vlan_pcp /* VLAN priority */
421 #define _SIZEOF_ADDR_IFREQ(ifr) \
422 ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
423 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
424 (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
427 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
428 struct sockaddr ifra_addr;
429 struct sockaddr ifra_broadaddr;
430 struct sockaddr ifra_mask;
436 char ifra_name[IFNAMSIZ];
437 struct sockaddr ifra_addr;
438 struct sockaddr ifra_broadaddr;
439 struct sockaddr ifra_mask;
443 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */
444 int ifm_current; /* current media options */
445 int ifm_mask; /* don't care mask */
446 int ifm_status; /* media status */
447 int ifm_active; /* active options */
448 int ifm_count; /* # entries in ifm_ulist array */
449 int *ifm_ulist; /* media words */
453 char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */
454 unsigned long ifd_cmd;
460 * Structure used to retrieve aux status data from interfaces.
461 * Kernel suppliers to this interface should respect the formatting
462 * needed by ifconfig(8): each line starts with a TAB and ends with
463 * a newline. The canonical example to copy and paste is in if_tun.c.
466 #define IFSTATMAX 800 /* 10 lines of text */
468 char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */
469 char ascii[IFSTATMAX + 1];
473 * Structure used in SIOCGIFCONF request.
474 * Used to retrieve interface configuration
475 * for machine (useful for programs which
476 * must know all networks accessible).
479 int ifc_len; /* size of associated buffer */
482 struct ifreq *ifcu_req;
484 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
485 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */
492 #define IFG_ALL "all" /* group contains all interfaces */
493 /* XXX: will we implement this? */
494 #define IFG_EGRESS "egress" /* if(s) default route(s) point to */
498 char ifgrqu_group[IFNAMSIZ];
499 char ifgrqu_member[IFNAMSIZ];
501 #define ifgrq_group ifgrq_ifgrqu.ifgrqu_group
502 #define ifgrq_member ifgrq_ifgrqu.ifgrqu_member
506 * Used to lookup groups for an interface
509 char ifgr_name[IFNAMSIZ];
512 char ifgru_group[IFNAMSIZ];
513 struct ifg_req *ifgru_groups;
515 #define ifgr_group ifgr_ifgru.ifgru_group
516 #define ifgr_groups ifgr_ifgru.ifgru_groups
520 * Structure used to request i2c data
521 * from interface transceivers.
524 uint8_t dev_addr; /* i2c address (0xA0, 0xA2) */
525 uint8_t offset; /* read offset */
526 uint8_t len; /* read length */
529 uint8_t data[8]; /* read buffer */
536 #define RSS_FUNC_NONE 0 /* RSS disabled */
537 #define RSS_FUNC_PRIVATE 1 /* non-standard */
538 #define RSS_FUNC_TOEPLITZ 2
540 #define RSS_TYPE_IPV4 0x00000001
541 #define RSS_TYPE_TCP_IPV4 0x00000002
542 #define RSS_TYPE_IPV6 0x00000004
543 #define RSS_TYPE_IPV6_EX 0x00000008
544 #define RSS_TYPE_TCP_IPV6 0x00000010
545 #define RSS_TYPE_TCP_IPV6_EX 0x00000020
546 #define RSS_TYPE_UDP_IPV4 0x00000040
547 #define RSS_TYPE_UDP_IPV6 0x00000080
548 #define RSS_TYPE_UDP_IPV6_EX 0x00000100
550 #define RSS_KEYLEN 128
553 char ifrk_name[IFNAMSIZ]; /* if name, e.g. "en0" */
554 uint8_t ifrk_func; /* RSS_FUNC_ */
556 uint16_t ifrk_keylen;
557 uint8_t ifrk_key[RSS_KEYLEN];
561 char ifrh_name[IFNAMSIZ]; /* if name, e.g. "en0" */
562 uint8_t ifrh_func; /* RSS_FUNC_ */
564 uint16_t ifrh_spare1;
565 uint32_t ifrh_types; /* RSS_TYPE_ */
568 #endif /* __BSD_VISIBLE */
571 #ifdef MALLOC_DECLARE
572 MALLOC_DECLARE(M_IFADDR);
573 MALLOC_DECLARE(M_IFMADDR);
578 struct if_nameindex {
579 unsigned int if_index; /* 1, 2, ... */
580 char *if_name; /* null terminated name: "le0", ... */
584 void if_freenameindex(struct if_nameindex *);
585 char *if_indextoname(unsigned int, char *);
586 struct if_nameindex *if_nameindex(void);
587 unsigned int if_nametoindex(const char *);
590 #endif /* !_NET_IF_H_ */