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