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