xref: /freebsd/sys/net/if_var.h (revision 47dd1d1b619cc035b82b49a91a25544309ff95ae)
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  *	From: @(#)if.h	8.1 (Berkeley) 6/10/93
32  * $FreeBSD$
33  */
34 
35 #ifndef	_NET_IF_VAR_H_
36 #define	_NET_IF_VAR_H_
37 
38 /*
39  * Structures defining a network interface, providing a packet
40  * transport mechanism (ala level 0 of the PUP protocols).
41  *
42  * Each interface accepts output datagrams of a specified maximum
43  * length, and provides higher level routines with input datagrams
44  * received from its medium.
45  *
46  * Output occurs when the routine if_output is called, with three parameters:
47  *	(*ifp->if_output)(ifp, m, dst, rt)
48  * Here m is the mbuf chain to be sent and dst is the destination address.
49  * The output routine encapsulates the supplied datagram if necessary,
50  * and then transmits it on its medium.
51  *
52  * On input, each interface unwraps the data received by it, and either
53  * places it on the input queue of an internetwork datagram routine
54  * and posts the associated software interrupt, or passes the datagram to a raw
55  * packet input routine.
56  *
57  * Routines exist for locating interfaces by their addresses
58  * or for locating an interface on a certain network, as well as more general
59  * routing and gateway routines maintaining information used to locate
60  * interfaces.  These routines live in the files if.c and route.c
61  */
62 
63 struct	rtentry;		/* ifa_rtrequest */
64 struct	rt_addrinfo;		/* ifa_rtrequest */
65 struct	socket;
66 struct	carp_if;
67 struct	carp_softc;
68 struct  ifvlantrunk;
69 struct	route;			/* if_output */
70 struct	vnet;
71 struct	ifmedia;
72 struct	netmap_adapter;
73 struct	netdump_methods;
74 
75 #ifdef _KERNEL
76 #include <sys/mbuf.h>		/* ifqueue only? */
77 #include <sys/buf_ring.h>
78 #include <net/vnet.h>
79 #include <ck_queue.h>
80 #include <sys/epoch.h>
81 #endif /* _KERNEL */
82 #include <sys/counter.h>
83 #include <sys/lock.h>		/* XXX */
84 #include <sys/mutex.h>		/* struct ifqueue */
85 #include <sys/rwlock.h>		/* XXX */
86 #include <sys/sx.h>		/* XXX */
87 #include <sys/_task.h>		/* if_link_task */
88 
89 #define	IF_DUNIT_NONE	-1
90 
91 #include <net/altq/if_altq.h>
92 
93 TAILQ_HEAD(ifnethead, ifnet);	/* we use TAILQs so that the order of */
94 TAILQ_HEAD(ifaddrhead, ifaddr);	/* instantiation is preserved in the list */
95 TAILQ_HEAD(ifmultihead, ifmultiaddr);
96 TAILQ_HEAD(ifgrouphead, ifg_group);
97 
98 #ifdef _KERNEL
99 VNET_DECLARE(struct pfil_head, link_pfil_hook);	/* packet filter hooks */
100 #define	V_link_pfil_hook	VNET(link_pfil_hook)
101 
102 #define	HHOOK_IPSEC_INET	0
103 #define	HHOOK_IPSEC_INET6	1
104 #define	HHOOK_IPSEC_COUNT	2
105 VNET_DECLARE(struct hhook_head *, ipsec_hhh_in[HHOOK_IPSEC_COUNT]);
106 VNET_DECLARE(struct hhook_head *, ipsec_hhh_out[HHOOK_IPSEC_COUNT]);
107 #define	V_ipsec_hhh_in	VNET(ipsec_hhh_in)
108 #define	V_ipsec_hhh_out	VNET(ipsec_hhh_out)
109 extern epoch_t net_epoch;
110 #endif /* _KERNEL */
111 
112 typedef enum {
113 	IFCOUNTER_IPACKETS = 0,
114 	IFCOUNTER_IERRORS,
115 	IFCOUNTER_OPACKETS,
116 	IFCOUNTER_OERRORS,
117 	IFCOUNTER_COLLISIONS,
118 	IFCOUNTER_IBYTES,
119 	IFCOUNTER_OBYTES,
120 	IFCOUNTER_IMCASTS,
121 	IFCOUNTER_OMCASTS,
122 	IFCOUNTER_IQDROPS,
123 	IFCOUNTER_OQDROPS,
124 	IFCOUNTER_NOPROTO,
125 	IFCOUNTERS /* Array size. */
126 } ift_counter;
127 
128 typedef struct ifnet * if_t;
129 
130 typedef	void (*if_start_fn_t)(if_t);
131 typedef	int (*if_ioctl_fn_t)(if_t, u_long, caddr_t);
132 typedef	void (*if_init_fn_t)(void *);
133 typedef void (*if_qflush_fn_t)(if_t);
134 typedef int (*if_transmit_fn_t)(if_t, struct mbuf *);
135 typedef	uint64_t (*if_get_counter_t)(if_t, ift_counter);
136 
137 struct ifnet_hw_tsomax {
138 	u_int	tsomaxbytes;	/* TSO total burst length limit in bytes */
139 	u_int	tsomaxsegcount;	/* TSO maximum segment count */
140 	u_int	tsomaxsegsize;	/* TSO maximum segment size in bytes */
141 };
142 
143 /* Interface encap request types */
144 typedef enum {
145 	IFENCAP_LL = 1			/* pre-calculate link-layer header */
146 } ife_type;
147 
148 /*
149  * The structure below allows to request various pre-calculated L2/L3 headers
150  * for different media. Requests varies by type (rtype field).
151  *
152  * IFENCAP_LL type: pre-calculates link header based on address family
153  *   and destination lladdr.
154  *
155  *   Input data fields:
156  *     buf: pointer to destination buffer
157  *     bufsize: buffer size
158  *     flags: IFENCAP_FLAG_BROADCAST if destination is broadcast
159  *     family: address family defined by AF_ constant.
160  *     lladdr: pointer to link-layer address
161  *     lladdr_len: length of link-layer address
162  *     hdata: pointer to L3 header (optional, used for ARP requests).
163  *   Output data fields:
164  *     buf: encap data is stored here
165  *     bufsize: resulting encap length is stored here
166  *     lladdr_off: offset of link-layer address from encap hdr start
167  *     hdata: L3 header may be altered if necessary
168  */
169 
170 struct if_encap_req {
171 	u_char		*buf;		/* Destination buffer (w) */
172 	size_t		bufsize;	/* size of provided buffer (r) */
173 	ife_type	rtype;		/* request type (r) */
174 	uint32_t	flags;		/* Request flags (r) */
175 	int		family;		/* Address family AF_* (r) */
176 	int		lladdr_off;	/* offset from header start (w) */
177 	int		lladdr_len;	/* lladdr length (r) */
178 	char		*lladdr;	/* link-level address pointer (r) */
179 	char		*hdata;		/* Upper layer header data (rw) */
180 };
181 
182 #define	IFENCAP_FLAG_BROADCAST	0x02	/* Destination is broadcast */
183 
184 /*
185  * Network interface send tag support. The storage of "struct
186  * m_snd_tag" comes from the network driver and it is free to allocate
187  * as much additional space as it wants for its own use.
188  */
189 struct m_snd_tag;
190 
191 #define	IF_SND_TAG_TYPE_RATE_LIMIT 0
192 #define	IF_SND_TAG_TYPE_UNLIMITED 1
193 #define	IF_SND_TAG_TYPE_MAX 2
194 
195 struct if_snd_tag_alloc_header {
196 	uint32_t type;		/* send tag type, see IF_SND_TAG_XXX */
197 	uint32_t flowid;	/* mbuf hash value */
198 	uint32_t flowtype;	/* mbuf hash type */
199 };
200 
201 struct if_snd_tag_alloc_rate_limit {
202 	struct if_snd_tag_alloc_header hdr;
203 	uint64_t max_rate;	/* in bytes/s */
204 };
205 
206 struct if_snd_tag_rate_limit_params {
207 	uint64_t max_rate;	/* in bytes/s */
208 	uint32_t queue_level;	/* 0 (empty) .. 65535 (full) */
209 #define	IF_SND_QUEUE_LEVEL_MIN 0
210 #define	IF_SND_QUEUE_LEVEL_MAX 65535
211 	uint32_t reserved;	/* padding */
212 };
213 
214 union if_snd_tag_alloc_params {
215 	struct if_snd_tag_alloc_header hdr;
216 	struct if_snd_tag_alloc_rate_limit rate_limit;
217 	struct if_snd_tag_alloc_rate_limit unlimited;
218 };
219 
220 union if_snd_tag_modify_params {
221 	struct if_snd_tag_rate_limit_params rate_limit;
222 	struct if_snd_tag_rate_limit_params unlimited;
223 };
224 
225 union if_snd_tag_query_params {
226 	struct if_snd_tag_rate_limit_params rate_limit;
227 	struct if_snd_tag_rate_limit_params unlimited;
228 };
229 
230 typedef int (if_snd_tag_alloc_t)(struct ifnet *, union if_snd_tag_alloc_params *,
231     struct m_snd_tag **);
232 typedef int (if_snd_tag_modify_t)(struct m_snd_tag *, union if_snd_tag_modify_params *);
233 typedef int (if_snd_tag_query_t)(struct m_snd_tag *, union if_snd_tag_query_params *);
234 typedef void (if_snd_tag_free_t)(struct m_snd_tag *);
235 
236 /*
237  * Structure defining a network interface.
238  */
239 struct ifnet {
240 	/* General book keeping of interface lists. */
241 	TAILQ_ENTRY(ifnet) if_link; 	/* all struct ifnets are chained */
242 	LIST_ENTRY(ifnet) if_clones;	/* interfaces of a cloner */
243 	TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
244 					/* protected by if_addr_lock */
245 	u_char	if_alloctype;		/* if_type at time of allocation */
246 
247 	/* Driver and protocol specific information that remains stable. */
248 	void	*if_softc;		/* pointer to driver state */
249 	void	*if_llsoftc;		/* link layer softc */
250 	void	*if_l2com;		/* pointer to protocol bits */
251 	const char *if_dname;		/* driver name */
252 	int	if_dunit;		/* unit or IF_DUNIT_NONE */
253 	u_short	if_index;		/* numeric abbreviation for this if  */
254 	short	if_index_reserved;	/* spare space to grow if_index */
255 	char	if_xname[IFNAMSIZ];	/* external name (name + unit) */
256 	char	*if_description;	/* interface description */
257 
258 	/* Variable fields that are touched by the stack and drivers. */
259 	int	if_flags;		/* up/down, broadcast, etc. */
260 	int	if_drv_flags;		/* driver-managed status flags */
261 	int	if_capabilities;	/* interface features & capabilities */
262 	int	if_capenable;		/* enabled features & capabilities */
263 	void	*if_linkmib;		/* link-type-specific MIB data */
264 	size_t	if_linkmiblen;		/* length of above data */
265 	u_int	if_refcount;		/* reference count */
266 
267 	/* These fields are shared with struct if_data. */
268 	uint8_t		if_type;	/* ethernet, tokenring, etc */
269 	uint8_t		if_addrlen;	/* media address length */
270 	uint8_t		if_hdrlen;	/* media header length */
271 	uint8_t		if_link_state;	/* current link state */
272 	uint32_t	if_mtu;		/* maximum transmission unit */
273 	uint32_t	if_metric;	/* routing metric (external only) */
274 	uint64_t	if_baudrate;	/* linespeed */
275 	uint64_t	if_hwassist;	/* HW offload capabilities, see IFCAP */
276 	time_t		if_epoch;	/* uptime at attach or stat reset */
277 	struct timeval	if_lastchange;	/* time of last administrative change */
278 
279 	struct  ifaltq if_snd;		/* output queue (includes altq) */
280 	struct	task if_linktask;	/* task for link change events */
281 
282 	/* Addresses of different protocol families assigned to this if. */
283 	struct	rwlock if_addr_lock;	/* lock to protect address lists */
284 		/*
285 		 * if_addrhead is the list of all addresses associated to
286 		 * an interface.
287 		 * Some code in the kernel assumes that first element
288 		 * of the list has type AF_LINK, and contains sockaddr_dl
289 		 * addresses which store the link-level address and the name
290 		 * of the interface.
291 		 * However, access to the AF_LINK address through this
292 		 * field is deprecated. Use if_addr or ifaddr_byindex() instead.
293 		 */
294 	struct	ifaddrhead if_addrhead;	/* linked list of addresses per if */
295 	struct	ifmultihead if_multiaddrs; /* multicast addresses configured */
296 	int	if_amcount;		/* number of all-multicast requests */
297 	struct	ifaddr	*if_addr;	/* pointer to link-level address */
298 	void	*if_hw_addr;		/* hardware link-level address */
299 	const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
300 	struct	rwlock if_afdata_lock;
301 	void	*if_afdata[AF_MAX];
302 	int	if_afdata_initialized;
303 
304 	/* Additional features hung off the interface. */
305 	u_int	if_fib;			/* interface FIB */
306 	struct	vnet *if_vnet;		/* pointer to network stack instance */
307 	struct	vnet *if_home_vnet;	/* where this ifnet originates from */
308 	struct  ifvlantrunk *if_vlantrunk; /* pointer to 802.1q data */
309 	struct	bpf_if *if_bpf;		/* packet filter structure */
310 	int	if_pcount;		/* number of promiscuous listeners */
311 	void	*if_bridge;		/* bridge glue */
312 	void	*if_lagg;		/* lagg glue */
313 	void	*if_pf_kif;		/* pf glue */
314 	struct	carp_if *if_carp;	/* carp interface structure */
315 	struct	label *if_label;	/* interface MAC label */
316 	struct	netmap_adapter *if_netmap; /* netmap(4) softc */
317 
318 	/* Various procedures of the layer2 encapsulation and drivers. */
319 	int	(*if_output)		/* output routine (enqueue) */
320 		(struct ifnet *, struct mbuf *, const struct sockaddr *,
321 		     struct route *);
322 	void	(*if_input)		/* input routine (from h/w driver) */
323 		(struct ifnet *, struct mbuf *);
324 	struct mbuf *(*if_bridge_input)(struct ifnet *, struct mbuf *);
325 	int	(*if_bridge_output)(struct ifnet *, struct mbuf *, struct sockaddr *,
326 		    struct rtentry *);
327 	void (*if_bridge_linkstate)(struct ifnet *ifp);
328 	if_start_fn_t	if_start;	/* initiate output routine */
329 	if_ioctl_fn_t	if_ioctl;	/* ioctl routine */
330 	if_init_fn_t	if_init;	/* Init routine */
331 	int	(*if_resolvemulti)	/* validate/resolve multicast */
332 		(struct ifnet *, struct sockaddr **, struct sockaddr *);
333 	if_qflush_fn_t	if_qflush;	/* flush any queue */
334 	if_transmit_fn_t if_transmit;   /* initiate output routine */
335 
336 	void	(*if_reassign)		/* reassign to vnet routine */
337 		(struct ifnet *, struct vnet *, char *);
338 	if_get_counter_t if_get_counter; /* get counter values */
339 	int	(*if_requestencap)	/* make link header from request */
340 		(struct ifnet *, struct if_encap_req *);
341 
342 	/* Statistics. */
343 	counter_u64_t	if_counters[IFCOUNTERS];
344 
345 	/* Stuff that's only temporary and doesn't belong here. */
346 
347 	/*
348 	 * Network adapter TSO limits:
349 	 * ===========================
350 	 *
351 	 * If the "if_hw_tsomax" field is zero the maximum segment
352 	 * length limit does not apply. If the "if_hw_tsomaxsegcount"
353 	 * or the "if_hw_tsomaxsegsize" field is zero the TSO segment
354 	 * count limit does not apply. If all three fields are zero,
355 	 * there is no TSO limit.
356 	 *
357 	 * NOTE: The TSO limits should reflect the values used in the
358 	 * BUSDMA tag a network adapter is using to load a mbuf chain
359 	 * for transmission. The TCP/IP network stack will subtract
360 	 * space for all linklevel and protocol level headers and
361 	 * ensure that the full mbuf chain passed to the network
362 	 * adapter fits within the given limits.
363 	 */
364 	u_int	if_hw_tsomax;		/* TSO maximum size in bytes */
365 	u_int	if_hw_tsomaxsegcount;	/* TSO maximum segment count */
366 	u_int	if_hw_tsomaxsegsize;	/* TSO maximum segment size in bytes */
367 
368 	/*
369 	 * Network adapter send tag support:
370 	 */
371 	if_snd_tag_alloc_t *if_snd_tag_alloc;
372 	if_snd_tag_modify_t *if_snd_tag_modify;
373 	if_snd_tag_query_t *if_snd_tag_query;
374 	if_snd_tag_free_t *if_snd_tag_free;
375 
376 	/* Ethernet PCP */
377 	uint8_t if_pcp;
378 
379 	/*
380 	 * Netdump hooks to be called while dumping.
381 	 */
382 	struct netdump_methods *if_netdump_methods;
383 
384 	/*
385 	 * Spare fields to be added before branching a stable branch, so
386 	 * that structure can be enhanced without changing the kernel
387 	 * binary interface.
388 	 */
389 	int	if_ispare[4];		/* general use */
390 };
391 
392 /* for compatibility with other BSDs */
393 #define	if_name(ifp)	((ifp)->if_xname)
394 
395 /*
396  * Locks for address lists on the network interface.
397  */
398 #define	IF_ADDR_LOCK_INIT(if)	rw_init(&(if)->if_addr_lock, "if_addr_lock")
399 #define	IF_ADDR_LOCK_DESTROY(if)	rw_destroy(&(if)->if_addr_lock)
400 #define	IF_ADDR_WLOCK(if)	rw_wlock(&(if)->if_addr_lock)
401 #define	IF_ADDR_WUNLOCK(if)	rw_wunlock(&(if)->if_addr_lock)
402 #define	IF_ADDR_RLOCK(if)	rw_rlock(&(if)->if_addr_lock)
403 #define	IF_ADDR_RUNLOCK(if)	rw_runlock(&(if)->if_addr_lock)
404 #define	IF_ADDR_LOCK_ASSERT(if)	rw_assert(&(if)->if_addr_lock, RA_LOCKED)
405 #define	IF_ADDR_WLOCK_ASSERT(if) rw_assert(&(if)->if_addr_lock, RA_WLOCKED)
406 
407 /*
408  * Function variations on locking macros intended to be used by loadable
409  * kernel modules in order to divorce them from the internals of address list
410  * locking.
411  */
412 void	if_addr_rlock(struct ifnet *ifp);	/* if_addrhead */
413 void	if_addr_runlock(struct ifnet *ifp);	/* if_addrhead */
414 void	if_maddr_rlock(if_t ifp);	/* if_multiaddrs */
415 void	if_maddr_runlock(if_t ifp);	/* if_multiaddrs */
416 
417 #ifdef _KERNEL
418 #ifdef _SYS_EVENTHANDLER_H_
419 /* interface link layer address change event */
420 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
421 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
422 /* interface address change event */
423 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
424 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
425 /* new interface arrival event */
426 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *);
427 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
428 /* interface departure event */
429 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *);
430 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
431 /* Interface link state change event */
432 typedef void (*ifnet_link_event_handler_t)(void *, struct ifnet *, int);
433 EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t);
434 /* Interface up/down event */
435 #define IFNET_EVENT_UP		0
436 #define IFNET_EVENT_DOWN	1
437 #define IFNET_EVENT_PCP		2	/* priority code point, PCP */
438 
439 typedef void (*ifnet_event_fn)(void *, struct ifnet *ifp, int event);
440 EVENTHANDLER_DECLARE(ifnet_event, ifnet_event_fn);
441 #endif /* _SYS_EVENTHANDLER_H_ */
442 
443 /*
444  * interface groups
445  */
446 struct ifg_group {
447 	char				 ifg_group[IFNAMSIZ];
448 	u_int				 ifg_refcnt;
449 	void				*ifg_pf_kif;
450 	TAILQ_HEAD(, ifg_member)	 ifg_members;
451 	TAILQ_ENTRY(ifg_group)		 ifg_next;
452 };
453 
454 struct ifg_member {
455 	TAILQ_ENTRY(ifg_member)	 ifgm_next;
456 	struct ifnet		*ifgm_ifp;
457 };
458 
459 struct ifg_list {
460 	struct ifg_group	*ifgl_group;
461 	TAILQ_ENTRY(ifg_list)	 ifgl_next;
462 };
463 
464 #ifdef _SYS_EVENTHANDLER_H_
465 /* group attach event */
466 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
467 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
468 /* group detach event */
469 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
470 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
471 /* group change event */
472 typedef void (*group_change_event_handler_t)(void *, const char *);
473 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
474 #endif /* _SYS_EVENTHANDLER_H_ */
475 
476 #define	IF_AFDATA_LOCK_INIT(ifp)	\
477 	rw_init(&(ifp)->if_afdata_lock, "if_afdata")
478 
479 #define	IF_AFDATA_WLOCK(ifp)	rw_wlock(&(ifp)->if_afdata_lock)
480 #define	IF_AFDATA_RLOCK(ifp)	rw_rlock(&(ifp)->if_afdata_lock)
481 #define	IF_AFDATA_WUNLOCK(ifp)	rw_wunlock(&(ifp)->if_afdata_lock)
482 #define	IF_AFDATA_RUNLOCK(ifp)	rw_runlock(&(ifp)->if_afdata_lock)
483 #define	IF_AFDATA_LOCK(ifp)	IF_AFDATA_WLOCK(ifp)
484 #define	IF_AFDATA_UNLOCK(ifp)	IF_AFDATA_WUNLOCK(ifp)
485 #define	IF_AFDATA_TRYLOCK(ifp)	rw_try_wlock(&(ifp)->if_afdata_lock)
486 #define	IF_AFDATA_DESTROY(ifp)	rw_destroy(&(ifp)->if_afdata_lock)
487 
488 #define	IF_AFDATA_LOCK_ASSERT(ifp)	rw_assert(&(ifp)->if_afdata_lock, RA_LOCKED)
489 #define	IF_AFDATA_RLOCK_ASSERT(ifp)	rw_assert(&(ifp)->if_afdata_lock, RA_RLOCKED)
490 #define	IF_AFDATA_WLOCK_ASSERT(ifp)	rw_assert(&(ifp)->if_afdata_lock, RA_WLOCKED)
491 #define	IF_AFDATA_UNLOCK_ASSERT(ifp)	rw_assert(&(ifp)->if_afdata_lock, RA_UNLOCKED)
492 
493 /*
494  * 72 was chosen below because it is the size of a TCP/IP
495  * header (40) + the minimum mss (32).
496  */
497 #define	IF_MINMTU	72
498 #define	IF_MAXMTU	65535
499 
500 #define	TOEDEV(ifp)	((ifp)->if_llsoftc)
501 
502 /*
503  * The ifaddr structure contains information about one address
504  * of an interface.  They are maintained by the different address families,
505  * are allocated and attached when an address is set, and are linked
506  * together so all addresses for an interface can be located.
507  *
508  * NOTE: a 'struct ifaddr' is always at the beginning of a larger
509  * chunk of malloc'ed memory, where we store the three addresses
510  * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
511  */
512 struct ifaddr {
513 	struct	sockaddr *ifa_addr;	/* address of interface */
514 	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
515 #define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
516 	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
517 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
518 	struct	carp_softc *ifa_carp;	/* pointer to CARP data */
519 	TAILQ_ENTRY(ifaddr) ifa_link;	/* queue macro glue */
520 	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
521 		(int, struct rtentry *, struct rt_addrinfo *);
522 	u_short	ifa_flags;		/* mostly rt_flags for cloning */
523 #define	IFA_ROUTE	RTF_UP		/* route installed */
524 #define	IFA_RTSELF	RTF_HOST	/* loopback route to self installed */
525 	u_int	ifa_refcnt;		/* references to this structure */
526 
527 	counter_u64_t	ifa_ipackets;
528 	counter_u64_t	ifa_opackets;
529 	counter_u64_t	ifa_ibytes;
530 	counter_u64_t	ifa_obytes;
531 };
532 
533 struct ifaddr *	ifa_alloc(size_t size, int flags);
534 void	ifa_free(struct ifaddr *ifa);
535 void	ifa_ref(struct ifaddr *ifa);
536 
537 /*
538  * Multicast address structure.  This is analogous to the ifaddr
539  * structure except that it keeps track of multicast addresses.
540  */
541 struct ifmultiaddr {
542 	TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
543 	struct	sockaddr *ifma_addr; 	/* address this membership is for */
544 	struct	sockaddr *ifma_lladdr;	/* link-layer translation, if any */
545 	struct	ifnet *ifma_ifp;	/* back-pointer to interface */
546 	u_int	ifma_refcount;		/* reference count */
547 	void	*ifma_protospec;	/* protocol-specific state, if any */
548 	struct	ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
549 };
550 
551 extern	struct rwlock ifnet_rwlock;
552 extern	struct sx ifnet_sxlock;
553 
554 #define	IFNET_WLOCK() do {						\
555 	sx_xlock(&ifnet_sxlock);					\
556 	rw_wlock(&ifnet_rwlock);					\
557 } while (0)
558 
559 #define	IFNET_WUNLOCK() do {						\
560 	rw_wunlock(&ifnet_rwlock);					\
561 	sx_xunlock(&ifnet_sxlock);					\
562 } while (0)
563 
564 /*
565  * To assert the ifnet lock, you must know not only whether it's for read or
566  * write, but also whether it was acquired with sleep support or not.
567  */
568 #define	IFNET_RLOCK_ASSERT()		sx_assert(&ifnet_sxlock, SA_SLOCKED)
569 #define	IFNET_RLOCK_NOSLEEP_ASSERT()	rw_assert(&ifnet_rwlock, RA_RLOCKED)
570 #define	IFNET_WLOCK_ASSERT() do {					\
571 	sx_assert(&ifnet_sxlock, SA_XLOCKED);				\
572 	rw_assert(&ifnet_rwlock, RA_WLOCKED);				\
573 } while (0)
574 
575 #define	IFNET_RLOCK()		sx_slock(&ifnet_sxlock)
576 #define	IFNET_RLOCK_NOSLEEP()	rw_rlock(&ifnet_rwlock)
577 #define	IFNET_RUNLOCK()		sx_sunlock(&ifnet_sxlock)
578 #define	IFNET_RUNLOCK_NOSLEEP()	rw_runlock(&ifnet_rwlock)
579 
580 /*
581  * Look up an ifnet given its index; the _ref variant also acquires a
582  * reference that must be freed using if_rele().  It is almost always a bug
583  * to call ifnet_byindex() instead of ifnet_byindex_ref().
584  */
585 struct ifnet	*ifnet_byindex(u_short idx);
586 struct ifnet	*ifnet_byindex_locked(u_short idx);
587 struct ifnet	*ifnet_byindex_ref(u_short idx);
588 
589 /*
590  * Given the index, ifaddr_byindex() returns the one and only
591  * link-level ifaddr for the interface. You are not supposed to use
592  * it to traverse the list of addresses associated to the interface.
593  */
594 struct ifaddr	*ifaddr_byindex(u_short idx);
595 
596 VNET_DECLARE(struct ifnethead, ifnet);
597 VNET_DECLARE(struct ifgrouphead, ifg_head);
598 VNET_DECLARE(int, if_index);
599 VNET_DECLARE(struct ifnet *, loif);	/* first loopback interface */
600 
601 #define	V_ifnet		VNET(ifnet)
602 #define	V_ifg_head	VNET(ifg_head)
603 #define	V_if_index	VNET(if_index)
604 #define	V_loif		VNET(loif)
605 
606 #ifdef MCAST_VERBOSE
607 #define MCDPRINTF printf
608 #else
609 #define MCDPRINTF(...)
610 #endif
611 
612 int	if_addgroup(struct ifnet *, const char *);
613 int	if_delgroup(struct ifnet *, const char *);
614 int	if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
615 int	if_allmulti(struct ifnet *, int);
616 struct	ifnet* if_alloc(u_char);
617 void	if_attach(struct ifnet *);
618 void	if_dead(struct ifnet *);
619 int	if_delmulti(struct ifnet *, struct sockaddr *);
620 void	if_delmulti_ifma(struct ifmultiaddr *);
621 void	if_delmulti_ifma_flags(struct ifmultiaddr *, int flags);
622 void	if_detach(struct ifnet *);
623 void	if_purgeaddrs(struct ifnet *);
624 void	if_delallmulti(struct ifnet *);
625 void	if_down(struct ifnet *);
626 struct ifmultiaddr *
627 	if_findmulti(struct ifnet *, const struct sockaddr *);
628 void	if_freemulti(struct ifmultiaddr *ifma);
629 void	if_free(struct ifnet *);
630 void	if_initname(struct ifnet *, const char *, int);
631 void	if_link_state_change(struct ifnet *, int);
632 int	if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
633 void	if_ref(struct ifnet *);
634 void	if_rele(struct ifnet *);
635 int	if_setlladdr(struct ifnet *, const u_char *, int);
636 void	if_up(struct ifnet *);
637 int	ifioctl(struct socket *, u_long, caddr_t, struct thread *);
638 int	ifpromisc(struct ifnet *, int);
639 struct	ifnet *ifunit(const char *);
640 struct	ifnet *ifunit_ref(const char *);
641 
642 int	ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
643 int	ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);
644 int	ifa_switch_loopback_route(struct ifaddr *, struct sockaddr *);
645 
646 struct	ifaddr *ifa_ifwithaddr(const struct sockaddr *);
647 int		ifa_ifwithaddr_check(const struct sockaddr *);
648 struct	ifaddr *ifa_ifwithbroadaddr(const struct sockaddr *, int);
649 struct	ifaddr *ifa_ifwithdstaddr(const struct sockaddr *, int);
650 struct	ifaddr *ifa_ifwithnet(const struct sockaddr *, int, int);
651 struct	ifaddr *ifa_ifwithroute(int, const struct sockaddr *, struct sockaddr *,
652     u_int);
653 struct	ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *);
654 int	ifa_preferred(struct ifaddr *, struct ifaddr *);
655 
656 int	if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
657 
658 typedef	void *if_com_alloc_t(u_char type, struct ifnet *ifp);
659 typedef	void if_com_free_t(void *com, u_char type);
660 void	if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
661 void	if_deregister_com_alloc(u_char type);
662 void	if_data_copy(struct ifnet *, struct if_data *);
663 uint64_t if_get_counter_default(struct ifnet *, ift_counter);
664 void	if_inc_counter(struct ifnet *, ift_counter, int64_t);
665 
666 #define IF_LLADDR(ifp)							\
667     LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr))
668 
669 uint64_t if_setbaudrate(if_t ifp, uint64_t baudrate);
670 uint64_t if_getbaudrate(if_t ifp);
671 int if_setcapabilities(if_t ifp, int capabilities);
672 int if_setcapabilitiesbit(if_t ifp, int setbit, int clearbit);
673 int if_getcapabilities(if_t ifp);
674 int if_togglecapenable(if_t ifp, int togglecap);
675 int if_setcapenable(if_t ifp, int capenable);
676 int if_setcapenablebit(if_t ifp, int setcap, int clearcap);
677 int if_getcapenable(if_t ifp);
678 const char *if_getdname(if_t ifp);
679 int if_setdev(if_t ifp, void *dev);
680 int if_setdrvflagbits(if_t ifp, int if_setflags, int clear_flags);
681 int if_getdrvflags(if_t ifp);
682 int if_setdrvflags(if_t ifp, int flags);
683 int if_clearhwassist(if_t ifp);
684 int if_sethwassistbits(if_t ifp, int toset, int toclear);
685 int if_sethwassist(if_t ifp, int hwassist_bit);
686 int if_gethwassist(if_t ifp);
687 int if_setsoftc(if_t ifp, void *softc);
688 void *if_getsoftc(if_t ifp);
689 int if_setflags(if_t ifp, int flags);
690 int if_gethwaddr(if_t ifp, struct ifreq *);
691 int if_setmtu(if_t ifp, int mtu);
692 int if_getmtu(if_t ifp);
693 int if_getmtu_family(if_t ifp, int family);
694 int if_setflagbits(if_t ifp, int set, int clear);
695 int if_getflags(if_t ifp);
696 int if_sendq_empty(if_t ifp);
697 int if_setsendqready(if_t ifp);
698 int if_setsendqlen(if_t ifp, int tx_desc_count);
699 int if_sethwtsomax(if_t ifp, u_int if_hw_tsomax);
700 int if_sethwtsomaxsegcount(if_t ifp, u_int if_hw_tsomaxsegcount);
701 int if_sethwtsomaxsegsize(if_t ifp, u_int if_hw_tsomaxsegsize);
702 u_int if_gethwtsomax(if_t ifp);
703 u_int if_gethwtsomaxsegcount(if_t ifp);
704 u_int if_gethwtsomaxsegsize(if_t ifp);
705 int if_input(if_t ifp, struct mbuf* sendmp);
706 int if_sendq_prepend(if_t ifp, struct mbuf *m);
707 struct mbuf *if_dequeue(if_t ifp);
708 int if_setifheaderlen(if_t ifp, int len);
709 void if_setrcvif(struct mbuf *m, if_t ifp);
710 void if_setvtag(struct mbuf *m, u_int16_t tag);
711 u_int16_t if_getvtag(struct mbuf *m);
712 int if_vlantrunkinuse(if_t ifp);
713 caddr_t if_getlladdr(if_t ifp);
714 void *if_gethandle(u_char);
715 void if_bpfmtap(if_t ifp, struct mbuf *m);
716 void if_etherbpfmtap(if_t ifp, struct mbuf *m);
717 void if_vlancap(if_t ifp);
718 
719 int if_setupmultiaddr(if_t ifp, void *mta, int *cnt, int max);
720 int if_multiaddr_array(if_t ifp, void *mta, int *cnt, int max);
721 int if_multiaddr_count(if_t ifp, int max);
722 
723 int if_multi_apply(struct ifnet *ifp, int (*filter)(void *, struct ifmultiaddr *, int), void *arg);
724 int if_getamcount(if_t ifp);
725 struct ifaddr * if_getifaddr(if_t ifp);
726 
727 /* Functions */
728 void if_setinitfn(if_t ifp, void (*)(void *));
729 void if_setioctlfn(if_t ifp, int (*)(if_t, u_long, caddr_t));
730 void if_setstartfn(if_t ifp, void (*)(if_t));
731 void if_settransmitfn(if_t ifp, if_transmit_fn_t);
732 void if_setqflushfn(if_t ifp, if_qflush_fn_t);
733 void if_setgetcounterfn(if_t ifp, if_get_counter_t);
734 
735 /* Revisit the below. These are inline functions originally */
736 int drbr_inuse_drv(if_t ifp, struct buf_ring *br);
737 struct mbuf* drbr_dequeue_drv(if_t ifp, struct buf_ring *br);
738 int drbr_needs_enqueue_drv(if_t ifp, struct buf_ring *br);
739 int drbr_enqueue_drv(if_t ifp, struct buf_ring *br, struct mbuf *m);
740 
741 /* TSO */
742 void if_hw_tsomax_common(if_t ifp, struct ifnet_hw_tsomax *);
743 int if_hw_tsomax_update(if_t ifp, struct ifnet_hw_tsomax *);
744 
745 /* accessors for struct ifreq */
746 void *ifr_data_get_ptr(void *ifrp);
747 
748 #ifdef DEVICE_POLLING
749 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS };
750 
751 typedef	int poll_handler_t(if_t ifp, enum poll_cmd cmd, int count);
752 int    ether_poll_register(poll_handler_t *h, if_t ifp);
753 int    ether_poll_deregister(if_t ifp);
754 #endif /* DEVICE_POLLING */
755 
756 #endif /* _KERNEL */
757 
758 #include <net/ifq.h>	/* XXXAO: temporary unconditional include */
759 
760 #endif /* !_NET_IF_VAR_H_ */
761