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>
40 * <net/if.h> does not depend on <sys/time.h> on most other systems. This
41 * helps userland compatibility. (struct timeval ifi_lastchange)
42 * The same holds for <sys/socket.h>. (struct sockaddr ifru_addr)
46 #include <sys/socket.h>
51 * Length of interface external name, including terminating '\0'.
52 * Note: this is the same size as a generic device's external name.
54 #define IF_NAMESIZE 16
56 #define IFNAMSIZ IF_NAMESIZE
57 #define IF_MAXUNIT 0x7fff /* historical value */
62 * Structure used to query names of interface cloners.
66 int ifcr_total; /* total cloners (out) */
67 int ifcr_count; /* room for this many in user buffer */
68 char *ifcr_buffer; /* buffer for cloner names */
72 * Structure describing information about an interface
73 * which may be of interest to management entities.
76 /* generic interface information */
77 u_char ifi_type; /* ethernet, tokenring, etc */
78 u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */
79 u_char ifi_addrlen; /* media address length */
80 u_char ifi_hdrlen; /* media header length */
81 u_char ifi_link_state; /* current link state */
82 u_char ifi_vhid; /* carp vhid */
83 u_char ifi_baudrate_pf; /* baudrate power factor */
84 u_char ifi_datalen; /* length of this data struct */
85 u_long ifi_mtu; /* maximum transmission unit */
86 u_long ifi_metric; /* routing metric (external only) */
87 u_long ifi_baudrate; /* linespeed */
88 /* volatile statistics */
89 u_long ifi_ipackets; /* packets received on interface */
90 u_long ifi_ierrors; /* input errors on interface */
91 u_long ifi_opackets; /* packets sent on interface */
92 u_long ifi_oerrors; /* output errors on interface */
93 u_long ifi_collisions; /* collisions on csma interfaces */
94 u_long ifi_ibytes; /* total number of octets received */
95 u_long ifi_obytes; /* total number of octets sent */
96 u_long ifi_imcasts; /* packets received via multicast */
97 u_long ifi_omcasts; /* packets sent via multicast */
98 u_long ifi_iqdrops; /* dropped on input, this interface */
99 u_long ifi_noproto; /* destined for unsupported protocol */
100 uint64_t ifi_hwassist; /* HW offload capabilities, see IFCAP */
101 time_t ifi_epoch; /* uptime at attach or stat reset */
102 struct timeval ifi_lastchange; /* time of last administrative change */
106 * Interface flags are of two types: network stack owned flags, and driver
107 * owned flags. Historically, these values were stored in the same ifnet
108 * flags field, but with the advent of fine-grained locking, they have been
109 * broken out such that the network stack is responsible for synchronizing
110 * the stack-owned fields, and the device driver the device-owned fields.
111 * Both halves can perform lockless reads of the other half's field, subject
112 * to accepting the involved races.
114 * Both sets of flags come from the same number space, and should not be
115 * permitted to conflict, as they are exposed to user space via a single
118 * The following symbols identify read and write requirements for fields:
120 * (i) if_flags field set by device driver before attach, read-only there
122 * (n) if_flags field written only by the network stack, read by either the
124 * (d) if_drv_flags field written only by the device driver, read by either
125 * the stack or driver.
127 #define IFF_UP 0x1 /* (n) interface is up */
128 #define IFF_BROADCAST 0x2 /* (i) broadcast address valid */
129 #define IFF_DEBUG 0x4 /* (n) turn on debugging */
130 #define IFF_LOOPBACK 0x8 /* (i) is a loopback net */
131 #define IFF_POINTOPOINT 0x10 /* (i) is a point-to-point link */
132 #define IFF_SMART 0x20 /* (i) interface manages own routes */
133 #define IFF_DRV_RUNNING 0x40 /* (d) resources allocated */
134 #define IFF_NOARP 0x80 /* (n) no address resolution protocol */
135 #define IFF_PROMISC 0x100 /* (n) receive all packets */
136 #define IFF_ALLMULTI 0x200 /* (n) receive all multicast packets */
137 #define IFF_DRV_OACTIVE 0x400 /* (d) tx hardware queue is full */
138 #define IFF_SIMPLEX 0x800 /* (i) can't hear own transmissions */
139 #define IFF_LINK0 0x1000 /* per link layer defined bit */
140 #define IFF_LINK1 0x2000 /* per link layer defined bit */
141 #define IFF_LINK2 0x4000 /* per link layer defined bit */
142 #define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */
143 #define IFF_MULTICAST 0x8000 /* (i) supports multicast */
144 #define IFF_CANTCONFIG 0x10000 /* (i) unconfigurable using ioctl(2) */
145 #define IFF_PPROMISC 0x20000 /* (n) user-requested promisc mode */
146 #define IFF_MONITOR 0x40000 /* (n) user-requested monitor mode */
147 #define IFF_STATICARP 0x80000 /* (n) static ARP */
148 #define IFF_DYING 0x200000 /* (n) interface is winding down */
149 #define IFF_RENAMING 0x400000 /* (n) interface is being renamed */
151 * Old names for driver flags so that user space tools can continue to use
152 * the old (portable) names.
155 #define IFF_RUNNING IFF_DRV_RUNNING
156 #define IFF_OACTIVE IFF_DRV_OACTIVE
159 /* flags set internally only: */
160 #define IFF_CANTCHANGE \
161 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_DRV_RUNNING|IFF_DRV_OACTIVE|\
162 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_PROMISC|\
163 IFF_DYING|IFF_CANTCONFIG)
166 * Values for if_link_state.
168 #define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */
169 #define LINK_STATE_DOWN 1 /* link is down */
170 #define LINK_STATE_UP 2 /* link is up */
173 * Some convenience macros used for setting ifi_baudrate.
174 * XXX 1000 vs. 1024? --thorpej@netbsd.org
176 #define IF_Kbps(x) ((uintmax_t)(x) * 1000) /* kilobits/sec. */
177 #define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */
178 #define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */
181 * Capabilities that interfaces can advertise.
183 * struct ifnet.if_capabilities
184 * contains the optional features & capabilities a particular interface
185 * supports (not only the driver but also the detected hw revision).
186 * Capabilities are defined by IFCAP_* below.
187 * struct ifnet.if_capenable
188 * contains the enabled (either by default or through ifconfig) optional
189 * features & capabilities on this interface.
190 * Capabilities are defined by IFCAP_* below.
191 * struct if_data.ifi_hwassist in mbuf CSUM_ flag form, controlled by above
192 * contains the enabled optional feature & capabilites that can be used
193 * individually per packet and are specified in the mbuf pkthdr.csum_flags
194 * field. IFCAP_* and CSUM_* do not match one to one and CSUM_* may be
195 * more detailed or differenciated than IFCAP_*.
196 * Hwassist features are defined CSUM_* in sys/mbuf.h
198 * Capabilities that cannot be arbitrarily changed with ifconfig/ioctl
199 * are listed in IFCAP_CANTCHANGE, similar to IFF_CANTCHANGE.
200 * This is not strictly necessary because the common code never
201 * changes capabilities, and it is left to the individual driver
202 * to do the right thing. However, having the filter here
203 * avoids replication of the same code in all individual drivers.
205 #define IFCAP_RXCSUM 0x00001 /* can offload checksum on RX */
206 #define IFCAP_TXCSUM 0x00002 /* can offload checksum on TX */
207 #define IFCAP_NETCONS 0x00004 /* can be a network console */
208 #define IFCAP_VLAN_MTU 0x00008 /* VLAN-compatible MTU */
209 #define IFCAP_VLAN_HWTAGGING 0x00010 /* hardware VLAN tag support */
210 #define IFCAP_JUMBO_MTU 0x00020 /* 9000 byte MTU supported */
211 #define IFCAP_POLLING 0x00040 /* driver supports polling */
212 #define IFCAP_VLAN_HWCSUM 0x00080 /* can do IFCAP_HWCSUM on VLANs */
213 #define IFCAP_TSO4 0x00100 /* can do TCP Segmentation Offload */
214 #define IFCAP_TSO6 0x00200 /* can do TCP6 Segmentation Offload */
215 #define IFCAP_LRO 0x00400 /* can do Large Receive Offload */
216 #define IFCAP_WOL_UCAST 0x00800 /* wake on any unicast frame */
217 #define IFCAP_WOL_MCAST 0x01000 /* wake on any multicast frame */
218 #define IFCAP_WOL_MAGIC 0x02000 /* wake on any Magic Packet */
219 #define IFCAP_TOE4 0x04000 /* interface can offload TCP */
220 #define IFCAP_TOE6 0x08000 /* interface can offload TCP6 */
221 #define IFCAP_VLAN_HWFILTER 0x10000 /* interface hw can filter vlan tag */
222 #define IFCAP_POLLING_NOCOUNT 0x20000 /* polling ticks cannot be fragmented */
223 #define IFCAP_VLAN_HWTSO 0x40000 /* can do IFCAP_TSO on VLANs */
224 #define IFCAP_LINKSTATE 0x80000 /* the runtime link state is dynamic */
225 #define IFCAP_NETMAP 0x100000 /* netmap mode supported/enabled */
226 #define IFCAP_RXCSUM_IPV6 0x200000 /* can offload checksum on IPv6 RX */
227 #define IFCAP_TXCSUM_IPV6 0x400000 /* can offload checksum on IPv6 TX */
228 #define IFCAP_HWSTATS 0x800000 /* manages counters internally */
230 #define IFCAP_HWCSUM_IPV6 (IFCAP_RXCSUM_IPV6 | IFCAP_TXCSUM_IPV6)
232 #define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM)
233 #define IFCAP_TSO (IFCAP_TSO4 | IFCAP_TSO6)
234 #define IFCAP_WOL (IFCAP_WOL_UCAST | IFCAP_WOL_MCAST | IFCAP_WOL_MAGIC)
235 #define IFCAP_TOE (IFCAP_TOE4 | IFCAP_TOE6)
237 #define IFCAP_CANTCHANGE (IFCAP_NETMAP)
239 #define IFQ_MAXLEN 50
240 #define IFNET_SLOWHZ 1 /* granularity is 1 second */
243 * Message format for use in obtaining information about interfaces
244 * from getkerninfo and the routing socket
245 * For the new, extensible interface see struct if_msghdrl below.
248 u_short ifm_msglen; /* to skip over non-understood messages */
249 u_char ifm_version; /* future binary compatibility */
250 u_char ifm_type; /* message type */
251 int ifm_addrs; /* like rtm_addrs */
252 int ifm_flags; /* value of if_flags */
253 u_short ifm_index; /* index for associated ifp */
254 struct if_data ifm_data;/* statistics and other data about if */
258 * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL. It is
259 * extensible after ifm_data_off or within ifm_data. Both the if_msghdr and
260 * if_data now have a member field detailing the struct length in addition to
261 * the routing message length. Macros are provided to find the start of
262 * ifm_data and the start of the socket address strucutres immediately following
263 * struct if_msghdrl given a pointer to struct if_msghdrl.
265 #define IF_MSGHDRL_IFM_DATA(_l) \
266 (struct if_data *)((char *)(_l) + (_l)->ifm_data_off)
267 #define IF_MSGHDRL_RTA(_l) \
268 (void *)((uintptr_t)(_l) + (_l)->ifm_len)
270 u_short ifm_msglen; /* to skip over non-understood messages */
271 u_char ifm_version; /* future binary compatibility */
272 u_char ifm_type; /* message type */
273 int ifm_addrs; /* like rtm_addrs */
274 int ifm_flags; /* value of if_flags */
275 u_short ifm_index; /* index for associated ifp */
276 u_short _ifm_spare1; /* spare space to grow if_index, see if_var.h */
277 u_short ifm_len; /* length of if_msghdrl incl. if_data */
278 u_short ifm_data_off; /* offset of if_data from beginning */
279 struct if_data ifm_data;/* statistics and other data about if */
283 * Message format for use in obtaining information about interface addresses
284 * from getkerninfo and the routing socket
285 * For the new, extensible interface see struct ifa_msghdrl below.
288 u_short ifam_msglen; /* to skip over non-understood messages */
289 u_char ifam_version; /* future binary compatibility */
290 u_char ifam_type; /* message type */
291 int ifam_addrs; /* like rtm_addrs */
292 int ifam_flags; /* value of ifa_flags */
293 u_short ifam_index; /* index for associated ifp */
294 int ifam_metric; /* value of ifa_metric */
298 * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL. It is
299 * extensible after ifam_metric or within ifam_data. Both the ifa_msghdrl and
300 * if_data now have a member field detailing the struct length in addition to
301 * the routing message length. Macros are provided to find the start of
302 * ifm_data and the start of the socket address strucutres immediately following
303 * struct ifa_msghdrl given a pointer to struct ifa_msghdrl.
305 #define IFA_MSGHDRL_IFAM_DATA(_l) \
306 (struct if_data *)((char *)(_l) + (_l)->ifam_data_off)
307 #define IFA_MSGHDRL_RTA(_l) \
308 (void *)((uintptr_t)(_l) + (_l)->ifam_len)
310 u_short ifam_msglen; /* to skip over non-understood messages */
311 u_char ifam_version; /* future binary compatibility */
312 u_char ifam_type; /* message type */
313 int ifam_addrs; /* like rtm_addrs */
314 int ifam_flags; /* value of ifa_flags */
315 u_short ifam_index; /* index for associated ifp */
316 u_short _ifam_spare1; /* spare space to grow if_index, see if_var.h */
317 u_short ifam_len; /* length of ifa_msghdrl incl. if_data */
318 u_short ifam_data_off; /* offset of if_data from beginning */
319 int ifam_metric; /* value of ifa_metric */
320 struct if_data ifam_data;/* statistics and other data about if or
325 * Message format for use in obtaining information about multicast addresses
326 * from the routing socket
329 u_short ifmam_msglen; /* to skip over non-understood messages */
330 u_char ifmam_version; /* future binary compatibility */
331 u_char ifmam_type; /* message type */
332 int ifmam_addrs; /* like rtm_addrs */
333 int ifmam_flags; /* value of ifa_flags */
334 u_short ifmam_index; /* index for associated ifp */
338 * Message format announcing the arrival or departure of a network interface.
340 struct if_announcemsghdr {
341 u_short ifan_msglen; /* to skip over non-understood messages */
342 u_char ifan_version; /* future binary compatibility */
343 u_char ifan_type; /* message type */
344 u_short ifan_index; /* index for associated ifp */
345 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
346 u_short ifan_what; /* what type of announcement */
349 #define IFAN_ARRIVAL 0 /* interface arrival */
350 #define IFAN_DEPARTURE 1 /* interface departure */
353 * Buffer with length to be used in SIOCGIFDESCR/SIOCSIFDESCR requests
355 struct ifreq_buffer {
361 * Interface request structure used for socket
362 * ioctl's. All interface ioctl's must have parameter
363 * definitions which begin with ifr_name. The
364 * remainder may be interface specific.
367 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */
369 struct sockaddr ifru_addr;
370 struct sockaddr ifru_dstaddr;
371 struct sockaddr ifru_broadaddr;
372 struct ifreq_buffer ifru_buffer;
384 #define ifr_addr ifr_ifru.ifru_addr /* address */
385 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */
386 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
387 #define ifr_buffer ifr_ifru.ifru_buffer /* user supplied buffer with its length */
388 #define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */
389 #define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */
390 #define ifr_jid ifr_ifru.ifru_jid /* jail/vnet */
391 #define ifr_metric ifr_ifru.ifru_metric /* metric */
392 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
393 #define ifr_phys ifr_ifru.ifru_phys /* physical wire */
394 #define ifr_media ifr_ifru.ifru_media /* physical media */
395 #define ifr_data ifr_ifru.ifru_data /* for use by interface */
396 #define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */
397 #define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */
398 #define ifr_index ifr_ifru.ifru_index /* interface index */
399 #define ifr_fib ifr_ifru.ifru_fib /* interface fib */
402 #define _SIZEOF_ADDR_IFREQ(ifr) \
403 ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
404 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
405 (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
408 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
409 struct sockaddr ifra_addr;
410 struct sockaddr ifra_broadaddr;
411 struct sockaddr ifra_mask;
416 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */
417 int ifm_current; /* current media options */
418 int ifm_mask; /* don't care mask */
419 int ifm_status; /* media status */
420 int ifm_active; /* active options */
421 int ifm_count; /* # entries in ifm_ulist array */
422 int *ifm_ulist; /* media words */
426 char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */
427 unsigned long ifd_cmd;
433 * Structure used to retrieve aux status data from interfaces.
434 * Kernel suppliers to this interface should respect the formatting
435 * needed by ifconfig(8): each line starts with a TAB and ends with
436 * a newline. The canonical example to copy and paste is in if_tun.c.
439 #define IFSTATMAX 800 /* 10 lines of text */
441 char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */
442 char ascii[IFSTATMAX + 1];
446 * Structure used in SIOCGIFCONF request.
447 * Used to retrieve interface configuration
448 * for machine (useful for programs which
449 * must know all networks accessible).
452 int ifc_len; /* size of associated buffer */
455 struct ifreq *ifcu_req;
457 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
458 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */
465 #define IFG_ALL "all" /* group contains all interfaces */
466 /* XXX: will we implement this? */
467 #define IFG_EGRESS "egress" /* if(s) default route(s) point to */
471 char ifgrqu_group[IFNAMSIZ];
472 char ifgrqu_member[IFNAMSIZ];
474 #define ifgrq_group ifgrq_ifgrqu.ifgrqu_group
475 #define ifgrq_member ifgrq_ifgrqu.ifgrqu_member
479 * Used to lookup groups for an interface
482 char ifgr_name[IFNAMSIZ];
485 char ifgru_group[IFNAMSIZ];
486 struct ifg_req *ifgru_groups;
488 #define ifgr_group ifgr_ifgru.ifgru_group
489 #define ifgr_groups ifgr_ifgru.ifgru_groups
493 * Structure for SIOC[AGD]LIFADDR
496 char iflr_name[IFNAMSIZ];
498 #define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */
499 u_int prefixlen; /* in/out */
500 struct sockaddr_storage addr; /* in/out */
501 struct sockaddr_storage dstaddr; /* out */
504 #endif /* __BSD_VISIBLE */
507 #ifdef MALLOC_DECLARE
508 MALLOC_DECLARE(M_IFADDR);
509 MALLOC_DECLARE(M_IFMADDR);
514 struct if_nameindex {
515 unsigned int if_index; /* 1, 2, ... */
516 char *if_name; /* null terminated name: "le0", ... */
520 void if_freenameindex(struct if_nameindex *);
521 char *if_indextoname(unsigned int, char *);
522 struct if_nameindex *if_nameindex(void);
523 unsigned int if_nametoindex(const char *);
526 #endif /* !_NET_IF_H_ */