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