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