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