xref: /freebsd/sys/net/if_var.h (revision 9517e866259191fcd39434a97ad849a9b59b9b9f)
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  *	From: @(#)if.h	8.1 (Berkeley) 6/10/93
30  * $FreeBSD$
31  */
32 
33 #ifndef	_NET_IF_VAR_H_
34 #define	_NET_IF_VAR_H_
35 
36 /*
37  * Structures defining a network interface, providing a packet
38  * transport mechanism (ala level 0 of the PUP protocols).
39  *
40  * Each interface accepts output datagrams of a specified maximum
41  * length, and provides higher level routines with input datagrams
42  * received from its medium.
43  *
44  * Output occurs when the routine if_output is called, with three parameters:
45  *	(*ifp->if_output)(ifp, m, dst, rt)
46  * Here m is the mbuf chain to be sent and dst is the destination address.
47  * The output routine encapsulates the supplied datagram if necessary,
48  * and then transmits it on its medium.
49  *
50  * On input, each interface unwraps the data received by it, and either
51  * places it on the input queue of an internetwork datagram routine
52  * and posts the associated software interrupt, or passes the datagram to a raw
53  * packet input routine.
54  *
55  * Routines exist for locating interfaces by their addresses
56  * or for locating an interface on a certain network, as well as more general
57  * routing and gateway routines maintaining information used to locate
58  * interfaces.  These routines live in the files if.c and route.c
59  */
60 
61 #ifdef __STDC__
62 /*
63  * Forward structure declarations for function prototypes [sic].
64  */
65 struct	mbuf;
66 struct	thread;
67 struct	rtentry;
68 struct	rt_addrinfo;
69 struct	socket;
70 struct	ether_header;
71 struct	carp_if;
72 struct  ifvlantrunk;
73 struct	route;
74 struct	vnet;
75 #endif
76 
77 #include <sys/queue.h>		/* get TAILQ macros */
78 
79 #ifdef _KERNEL
80 #include <sys/mbuf.h>
81 #include <sys/eventhandler.h>
82 #include <sys/buf_ring.h>
83 #include <net/vnet.h>
84 #endif /* _KERNEL */
85 #include <sys/lock.h>		/* XXX */
86 #include <sys/mutex.h>		/* XXX */
87 #include <sys/rwlock.h>		/* XXX */
88 #include <sys/event.h>		/* XXX */
89 #include <sys/_task.h>
90 
91 #define	IF_DUNIT_NONE	-1
92 
93 #include <altq/if_altq.h>
94 
95 TAILQ_HEAD(ifnethead, ifnet);	/* we use TAILQs so that the order of */
96 TAILQ_HEAD(ifaddrhead, ifaddr);	/* instantiation is preserved in the list */
97 TAILQ_HEAD(ifprefixhead, ifprefix);
98 TAILQ_HEAD(ifmultihead, ifmultiaddr);
99 TAILQ_HEAD(ifgrouphead, ifg_group);
100 
101 /*
102  * Structure defining a queue for a network interface.
103  */
104 struct	ifqueue {
105 	struct	mbuf *ifq_head;
106 	struct	mbuf *ifq_tail;
107 	int	ifq_len;
108 	int	ifq_maxlen;
109 	int	ifq_drops;
110 	struct	mtx ifq_mtx;
111 };
112 
113 /*
114  * Structure defining a network interface.
115  *
116  * (Would like to call this struct ``if'', but C isn't PL/1.)
117  */
118 
119 struct ifnet {
120 	void	*if_softc;		/* pointer to driver state */
121 	void	*if_l2com;		/* pointer to protocol bits */
122 	struct vnet *if_vnet;		/* pointer to network stack instance */
123 	TAILQ_ENTRY(ifnet) if_link; 	/* all struct ifnets are chained */
124 	char	if_xname[IFNAMSIZ];	/* external name (name + unit) */
125 	const char *if_dname;		/* driver name */
126 	int	if_dunit;		/* unit or IF_DUNIT_NONE */
127 	u_int	if_refcount;		/* reference count */
128 	struct	ifaddrhead if_addrhead;	/* linked list of addresses per if */
129 		/*
130 		 * if_addrhead is the list of all addresses associated to
131 		 * an interface.
132 		 * Some code in the kernel assumes that first element
133 		 * of the list has type AF_LINK, and contains sockaddr_dl
134 		 * addresses which store the link-level address and the name
135 		 * of the interface.
136 		 * However, access to the AF_LINK address through this
137 		 * field is deprecated. Use if_addr or ifaddr_byindex() instead.
138 		 */
139 	int	if_pcount;		/* number of promiscuous listeners */
140 	struct	carp_if *if_carp;	/* carp interface structure */
141 	struct	bpf_if *if_bpf;		/* packet filter structure */
142 	u_short	if_index;		/* numeric abbreviation for this if  */
143 	short	if_timer;		/* time 'til if_watchdog called */
144 	struct  ifvlantrunk *if_vlantrunk; /* pointer to 802.1q data */
145 	int	if_flags;		/* up/down, broadcast, etc. */
146 	int	if_capabilities;	/* interface features & capabilities */
147 	int	if_capenable;		/* enabled features & capabilities */
148 	void	*if_linkmib;		/* link-type-specific MIB data */
149 	size_t	if_linkmiblen;		/* length of above data */
150 	struct	if_data if_data;
151 	struct	ifmultihead if_multiaddrs; /* multicast addresses configured */
152 	int	if_amcount;		/* number of all-multicast requests */
153 /* procedure handles */
154 	int	(*if_output)		/* output routine (enqueue) */
155 		(struct ifnet *, struct mbuf *, struct sockaddr *,
156 		     struct route *);
157 	void	(*if_input)		/* input routine (from h/w driver) */
158 		(struct ifnet *, struct mbuf *);
159 	void	(*if_start)		/* initiate output routine */
160 		(struct ifnet *);
161 	int	(*if_ioctl)		/* ioctl routine */
162 		(struct ifnet *, u_long, caddr_t);
163 	void	(*if_watchdog)		/* timer routine */
164 		(struct ifnet *);
165 	void	(*if_init)		/* Init routine */
166 		(void *);
167 	int	(*if_resolvemulti)	/* validate/resolve multicast */
168 		(struct ifnet *, struct sockaddr **, struct sockaddr *);
169 	void	(*if_qflush)		/* flush any queues */
170 		(struct ifnet *);
171 	int	(*if_transmit)		/* initiate output routine */
172 		(struct ifnet *, struct mbuf *);
173 	void	(*if_reassign)		/* reassign to vnet routine */
174 		(struct ifnet *, struct vnet *, char *);
175 	struct	vnet *if_home_vnet;	/* where this ifnet originates from */
176 	struct	ifaddr	*if_addr;	/* pointer to link-level address */
177 	void	*if_llsoftc;		/* link layer softc */
178 	int	if_drv_flags;		/* driver-managed status flags */
179 	struct  ifaltq if_snd;		/* output queue (includes altq) */
180 	const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
181 
182 	void	*if_bridge;		/* bridge glue */
183 
184 	struct	label *if_label;	/* interface MAC label */
185 
186 	/* these are only used by IPv6 */
187 	struct	ifprefixhead if_prefixhead; /* list of prefixes per if */
188 	void	*if_afdata[AF_MAX];
189 	int	if_afdata_initialized;
190 	struct	rwlock if_afdata_lock;
191 	struct	task if_linktask;	/* task for link change events */
192 	struct	mtx if_addr_mtx;	/* mutex to protect address lists */
193 
194 	LIST_ENTRY(ifnet) if_clones;	/* interfaces of a cloner */
195 	TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
196 					/* protected by if_addr_mtx */
197 	void	*if_pf_kif;
198 	void	*if_lagg;		/* lagg glue */
199 	u_char	 if_alloctype;		/* if_type at time of allocation */
200 
201 	/*
202 	 * Spare fields are added so that we can modify sensitive data
203 	 * structures without changing the kernel binary interface, and must
204 	 * be used with care where binary compatibility is required.
205 	 */
206 	char	 if_cspare[3];
207 	void	*if_pspare[8];
208 	int	if_ispare[4];
209 };
210 
211 typedef void if_init_f_t(void *);
212 
213 /*
214  * XXX These aliases are terribly dangerous because they could apply
215  * to anything.
216  */
217 #define	if_mtu		if_data.ifi_mtu
218 #define	if_type		if_data.ifi_type
219 #define if_physical	if_data.ifi_physical
220 #define	if_addrlen	if_data.ifi_addrlen
221 #define	if_hdrlen	if_data.ifi_hdrlen
222 #define	if_metric	if_data.ifi_metric
223 #define	if_link_state	if_data.ifi_link_state
224 #define	if_baudrate	if_data.ifi_baudrate
225 #define	if_hwassist	if_data.ifi_hwassist
226 #define	if_ipackets	if_data.ifi_ipackets
227 #define	if_ierrors	if_data.ifi_ierrors
228 #define	if_opackets	if_data.ifi_opackets
229 #define	if_oerrors	if_data.ifi_oerrors
230 #define	if_collisions	if_data.ifi_collisions
231 #define	if_ibytes	if_data.ifi_ibytes
232 #define	if_obytes	if_data.ifi_obytes
233 #define	if_imcasts	if_data.ifi_imcasts
234 #define	if_omcasts	if_data.ifi_omcasts
235 #define	if_iqdrops	if_data.ifi_iqdrops
236 #define	if_noproto	if_data.ifi_noproto
237 #define	if_lastchange	if_data.ifi_lastchange
238 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)NULL)
239 
240 /* for compatibility with other BSDs */
241 #define	if_addrlist	if_addrhead
242 #define	if_list		if_link
243 #define	if_name(ifp)	((ifp)->if_xname)
244 
245 /*
246  * Locks for address lists on the network interface.
247  */
248 #define	IF_ADDR_LOCK_INIT(if)	mtx_init(&(if)->if_addr_mtx,		\
249 				    "if_addr_mtx", NULL, MTX_DEF)
250 #define	IF_ADDR_LOCK_DESTROY(if)	mtx_destroy(&(if)->if_addr_mtx)
251 #define	IF_ADDR_LOCK(if)	mtx_lock(&(if)->if_addr_mtx)
252 #define	IF_ADDR_UNLOCK(if)	mtx_unlock(&(if)->if_addr_mtx)
253 #define	IF_ADDR_LOCK_ASSERT(if)	mtx_assert(&(if)->if_addr_mtx, MA_OWNED)
254 
255 /*
256  * Function variations on locking macros intended to be used by loadable
257  * kernel modules in order to divorce them from the internals of address list
258  * locking.
259  */
260 void	if_addr_rlock(struct ifnet *ifp);	/* if_addrhead */
261 void	if_addr_runlock(struct ifnet *ifp);	/* if_addrhead */
262 void	if_maddr_rlock(struct ifnet *ifp);	/* if_multiaddrs */
263 void	if_maddr_runlock(struct ifnet *ifp);	/* if_multiaddrs */
264 
265 /*
266  * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
267  * are queues of messages stored on ifqueue structures
268  * (defined above).  Entries are added to and deleted from these structures
269  * by these macros, which should be called with ipl raised to splimp().
270  */
271 #define IF_LOCK(ifq)		mtx_lock(&(ifq)->ifq_mtx)
272 #define IF_UNLOCK(ifq)		mtx_unlock(&(ifq)->ifq_mtx)
273 #define	IF_LOCK_ASSERT(ifq)	mtx_assert(&(ifq)->ifq_mtx, MA_OWNED)
274 #define	_IF_QFULL(ifq)		((ifq)->ifq_len >= (ifq)->ifq_maxlen)
275 #define	_IF_DROP(ifq)		((ifq)->ifq_drops++)
276 #define	_IF_QLEN(ifq)		((ifq)->ifq_len)
277 
278 #define	_IF_ENQUEUE(ifq, m) do { 				\
279 	(m)->m_nextpkt = NULL;					\
280 	if ((ifq)->ifq_tail == NULL) 				\
281 		(ifq)->ifq_head = m; 				\
282 	else 							\
283 		(ifq)->ifq_tail->m_nextpkt = m; 		\
284 	(ifq)->ifq_tail = m; 					\
285 	(ifq)->ifq_len++; 					\
286 } while (0)
287 
288 #define IF_ENQUEUE(ifq, m) do {					\
289 	IF_LOCK(ifq); 						\
290 	_IF_ENQUEUE(ifq, m); 					\
291 	IF_UNLOCK(ifq); 					\
292 } while (0)
293 
294 #define	_IF_PREPEND(ifq, m) do {				\
295 	(m)->m_nextpkt = (ifq)->ifq_head; 			\
296 	if ((ifq)->ifq_tail == NULL) 				\
297 		(ifq)->ifq_tail = (m); 				\
298 	(ifq)->ifq_head = (m); 					\
299 	(ifq)->ifq_len++; 					\
300 } while (0)
301 
302 #define IF_PREPEND(ifq, m) do {		 			\
303 	IF_LOCK(ifq); 						\
304 	_IF_PREPEND(ifq, m); 					\
305 	IF_UNLOCK(ifq); 					\
306 } while (0)
307 
308 #define	_IF_DEQUEUE(ifq, m) do { 				\
309 	(m) = (ifq)->ifq_head; 					\
310 	if (m) { 						\
311 		if (((ifq)->ifq_head = (m)->m_nextpkt) == NULL)	\
312 			(ifq)->ifq_tail = NULL; 		\
313 		(m)->m_nextpkt = NULL; 				\
314 		(ifq)->ifq_len--; 				\
315 	} 							\
316 } while (0)
317 
318 #define IF_DEQUEUE(ifq, m) do { 				\
319 	IF_LOCK(ifq); 						\
320 	_IF_DEQUEUE(ifq, m); 					\
321 	IF_UNLOCK(ifq); 					\
322 } while (0)
323 
324 #define	_IF_POLL(ifq, m)	((m) = (ifq)->ifq_head)
325 #define	IF_POLL(ifq, m)		_IF_POLL(ifq, m)
326 
327 #define _IF_DRAIN(ifq) do { 					\
328 	struct mbuf *m; 					\
329 	for (;;) { 						\
330 		_IF_DEQUEUE(ifq, m); 				\
331 		if (m == NULL) 					\
332 			break; 					\
333 		m_freem(m); 					\
334 	} 							\
335 } while (0)
336 
337 #define IF_DRAIN(ifq) do {					\
338 	IF_LOCK(ifq);						\
339 	_IF_DRAIN(ifq);						\
340 	IF_UNLOCK(ifq);						\
341 } while(0)
342 
343 #ifdef _KERNEL
344 /* interface address change event */
345 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
346 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
347 /* new interface arrival event */
348 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *);
349 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
350 /* interface departure event */
351 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *);
352 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
353 
354 /*
355  * interface groups
356  */
357 struct ifg_group {
358 	char				 ifg_group[IFNAMSIZ];
359 	u_int				 ifg_refcnt;
360 	void				*ifg_pf_kif;
361 	TAILQ_HEAD(, ifg_member)	 ifg_members;
362 	TAILQ_ENTRY(ifg_group)		 ifg_next;
363 };
364 
365 struct ifg_member {
366 	TAILQ_ENTRY(ifg_member)	 ifgm_next;
367 	struct ifnet		*ifgm_ifp;
368 };
369 
370 struct ifg_list {
371 	struct ifg_group	*ifgl_group;
372 	TAILQ_ENTRY(ifg_list)	 ifgl_next;
373 };
374 
375 /* group attach event */
376 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
377 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
378 /* group detach event */
379 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
380 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
381 /* group change event */
382 typedef void (*group_change_event_handler_t)(void *, const char *);
383 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
384 
385 #define	IF_AFDATA_LOCK_INIT(ifp)	\
386 	rw_init(&(ifp)->if_afdata_lock, "if_afdata")
387 
388 #define	IF_AFDATA_WLOCK(ifp)	rw_wlock(&(ifp)->if_afdata_lock)
389 #define	IF_AFDATA_RLOCK(ifp)	rw_rlock(&(ifp)->if_afdata_lock)
390 #define	IF_AFDATA_WUNLOCK(ifp)	rw_wunlock(&(ifp)->if_afdata_lock)
391 #define	IF_AFDATA_RUNLOCK(ifp)	rw_runlock(&(ifp)->if_afdata_lock)
392 #define	IF_AFDATA_LOCK(ifp)	IF_AFDATA_WLOCK(ifp)
393 #define	IF_AFDATA_UNLOCK(ifp)	IF_AFDATA_WUNLOCK(ifp)
394 #define	IF_AFDATA_TRYLOCK(ifp)	rw_try_wlock(&(ifp)->if_afdata_lock)
395 #define	IF_AFDATA_DESTROY(ifp)	rw_destroy(&(ifp)->if_afdata_lock)
396 
397 #define	IF_AFDATA_LOCK_ASSERT(ifp)	rw_assert(&(ifp)->if_afdata_lock, RA_LOCKED)
398 #define	IF_AFDATA_UNLOCK_ASSERT(ifp)	rw_assert(&(ifp)->if_afdata_lock, RA_UNLOCKED)
399 
400 int	if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp,
401 	    int adjust);
402 #define	IF_HANDOFF(ifq, m, ifp)			\
403 	if_handoff((struct ifqueue *)ifq, m, ifp, 0)
404 #define	IF_HANDOFF_ADJ(ifq, m, ifp, adj)	\
405 	if_handoff((struct ifqueue *)ifq, m, ifp, adj)
406 
407 void	if_start(struct ifnet *);
408 
409 #define	IFQ_ENQUEUE(ifq, m, err)					\
410 do {									\
411 	IF_LOCK(ifq);							\
412 	if (ALTQ_IS_ENABLED(ifq))					\
413 		ALTQ_ENQUEUE(ifq, m, NULL, err);			\
414 	else {								\
415 		if (_IF_QFULL(ifq)) {					\
416 			m_freem(m);					\
417 			(err) = ENOBUFS;				\
418 		} else {						\
419 			_IF_ENQUEUE(ifq, m);				\
420 			(err) = 0;					\
421 		}							\
422 	}								\
423 	if (err)							\
424 		(ifq)->ifq_drops++;					\
425 	IF_UNLOCK(ifq);							\
426 } while (0)
427 
428 #define	IFQ_DEQUEUE_NOLOCK(ifq, m)					\
429 do {									\
430 	if (TBR_IS_ENABLED(ifq))					\
431 		(m) = tbr_dequeue_ptr(ifq, ALTDQ_REMOVE);		\
432 	else if (ALTQ_IS_ENABLED(ifq))					\
433 		ALTQ_DEQUEUE(ifq, m);					\
434 	else								\
435 		_IF_DEQUEUE(ifq, m);					\
436 } while (0)
437 
438 #define	IFQ_DEQUEUE(ifq, m)						\
439 do {									\
440 	IF_LOCK(ifq);							\
441 	IFQ_DEQUEUE_NOLOCK(ifq, m);					\
442 	IF_UNLOCK(ifq);							\
443 } while (0)
444 
445 #define	IFQ_POLL_NOLOCK(ifq, m)						\
446 do {									\
447 	if (TBR_IS_ENABLED(ifq))					\
448 		(m) = tbr_dequeue_ptr(ifq, ALTDQ_POLL);			\
449 	else if (ALTQ_IS_ENABLED(ifq))					\
450 		ALTQ_POLL(ifq, m);					\
451 	else								\
452 		_IF_POLL(ifq, m);					\
453 } while (0)
454 
455 #define	IFQ_POLL(ifq, m)						\
456 do {									\
457 	IF_LOCK(ifq);							\
458 	IFQ_POLL_NOLOCK(ifq, m);					\
459 	IF_UNLOCK(ifq);							\
460 } while (0)
461 
462 #define	IFQ_PURGE_NOLOCK(ifq)						\
463 do {									\
464 	if (ALTQ_IS_ENABLED(ifq)) {					\
465 		ALTQ_PURGE(ifq);					\
466 	} else								\
467 		_IF_DRAIN(ifq);						\
468 } while (0)
469 
470 #define	IFQ_PURGE(ifq)							\
471 do {									\
472 	IF_LOCK(ifq);							\
473 	IFQ_PURGE_NOLOCK(ifq);						\
474 	IF_UNLOCK(ifq);							\
475 } while (0)
476 
477 #define	IFQ_SET_READY(ifq)						\
478 	do { ((ifq)->altq_flags |= ALTQF_READY); } while (0)
479 
480 #define	IFQ_LOCK(ifq)			IF_LOCK(ifq)
481 #define	IFQ_UNLOCK(ifq)			IF_UNLOCK(ifq)
482 #define	IFQ_LOCK_ASSERT(ifq)		IF_LOCK_ASSERT(ifq)
483 #define	IFQ_IS_EMPTY(ifq)		((ifq)->ifq_len == 0)
484 #define	IFQ_INC_LEN(ifq)		((ifq)->ifq_len++)
485 #define	IFQ_DEC_LEN(ifq)		(--(ifq)->ifq_len)
486 #define	IFQ_INC_DROPS(ifq)		((ifq)->ifq_drops++)
487 #define	IFQ_SET_MAXLEN(ifq, len)	((ifq)->ifq_maxlen = (len))
488 
489 /*
490  * The IFF_DRV_OACTIVE test should really occur in the device driver, not in
491  * the handoff logic, as that flag is locked by the device driver.
492  */
493 #define	IFQ_HANDOFF_ADJ(ifp, m, adj, err)				\
494 do {									\
495 	int len;							\
496 	short mflags;							\
497 									\
498 	len = (m)->m_pkthdr.len;					\
499 	mflags = (m)->m_flags;						\
500 	IFQ_ENQUEUE(&(ifp)->if_snd, m, err);				\
501 	if ((err) == 0) {						\
502 		(ifp)->if_obytes += len + (adj);			\
503 		if (mflags & M_MCAST)					\
504 			(ifp)->if_omcasts++;				\
505 		if (((ifp)->if_drv_flags & IFF_DRV_OACTIVE) == 0)	\
506 			if_start(ifp);					\
507 	}								\
508 } while (0)
509 
510 #define	IFQ_HANDOFF(ifp, m, err)					\
511 	IFQ_HANDOFF_ADJ(ifp, m, 0, err)
512 
513 #define	IFQ_DRV_DEQUEUE(ifq, m)						\
514 do {									\
515 	(m) = (ifq)->ifq_drv_head;					\
516 	if (m) {							\
517 		if (((ifq)->ifq_drv_head = (m)->m_nextpkt) == NULL)	\
518 			(ifq)->ifq_drv_tail = NULL;			\
519 		(m)->m_nextpkt = NULL;					\
520 		(ifq)->ifq_drv_len--;					\
521 	} else {							\
522 		IFQ_LOCK(ifq);						\
523 		IFQ_DEQUEUE_NOLOCK(ifq, m);				\
524 		while ((ifq)->ifq_drv_len < (ifq)->ifq_drv_maxlen) {	\
525 			struct mbuf *m0;				\
526 			IFQ_DEQUEUE_NOLOCK(ifq, m0);			\
527 			if (m0 == NULL)					\
528 				break;					\
529 			m0->m_nextpkt = NULL;				\
530 			if ((ifq)->ifq_drv_tail == NULL)		\
531 				(ifq)->ifq_drv_head = m0;		\
532 			else						\
533 				(ifq)->ifq_drv_tail->m_nextpkt = m0;	\
534 			(ifq)->ifq_drv_tail = m0;			\
535 			(ifq)->ifq_drv_len++;				\
536 		}							\
537 		IFQ_UNLOCK(ifq);					\
538 	}								\
539 } while (0)
540 
541 #define	IFQ_DRV_PREPEND(ifq, m)						\
542 do {									\
543 	(m)->m_nextpkt = (ifq)->ifq_drv_head;				\
544 	if ((ifq)->ifq_drv_tail == NULL)				\
545 		(ifq)->ifq_drv_tail = (m);				\
546 	(ifq)->ifq_drv_head = (m);					\
547 	(ifq)->ifq_drv_len++;						\
548 } while (0)
549 
550 #define	IFQ_DRV_IS_EMPTY(ifq)						\
551 	(((ifq)->ifq_drv_len == 0) && ((ifq)->ifq_len == 0))
552 
553 #define	IFQ_DRV_PURGE(ifq)						\
554 do {									\
555 	struct mbuf *m, *n = (ifq)->ifq_drv_head;			\
556 	while((m = n) != NULL) {					\
557 		n = m->m_nextpkt;					\
558 		m_freem(m);						\
559 	}								\
560 	(ifq)->ifq_drv_head = (ifq)->ifq_drv_tail = NULL;		\
561 	(ifq)->ifq_drv_len = 0;						\
562 	IFQ_PURGE(ifq);							\
563 } while (0)
564 
565 #ifdef _KERNEL
566 static __inline void
567 drbr_stats_update(struct ifnet *ifp, int len, int mflags)
568 {
569 #ifndef NO_SLOW_STATS
570 	ifp->if_obytes += len;
571 	if (mflags & M_MCAST)
572 		ifp->if_omcasts++;
573 #endif
574 }
575 
576 static __inline int
577 drbr_enqueue(struct ifnet *ifp, struct buf_ring *br, struct mbuf *m)
578 {
579 	int error = 0;
580 	int len = m->m_pkthdr.len;
581 	int mflags = m->m_flags;
582 
583 #ifdef ALTQ
584 	if (ALTQ_IS_ENABLED(&ifp->if_snd)) {
585 		IFQ_ENQUEUE(&ifp->if_snd, m, error);
586 		return (error);
587 	}
588 #endif
589 	if ((error = buf_ring_enqueue_bytes(br, m, len)) == ENOBUFS) {
590 		br->br_drops++;
591 		m_freem(m);
592 	} else
593 		drbr_stats_update(ifp, len, mflags);
594 
595 	return (error);
596 }
597 
598 static __inline void
599 drbr_flush(struct ifnet *ifp, struct buf_ring *br)
600 {
601 	struct mbuf *m;
602 
603 #ifdef ALTQ
604 	if (ifp != NULL && ALTQ_IS_ENABLED(&ifp->if_snd)) {
605 		while (!IFQ_IS_EMPTY(&ifp->if_snd)) {
606 			IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
607 			m_freem(m);
608 		}
609 	}
610 #endif
611 	while ((m = buf_ring_dequeue_sc(br)) != NULL)
612 		m_freem(m);
613 }
614 
615 static __inline void
616 drbr_free(struct buf_ring *br, struct malloc_type *type)
617 {
618 
619 	drbr_flush(NULL, br);
620 	buf_ring_free(br, type);
621 }
622 
623 static __inline struct mbuf *
624 drbr_dequeue(struct ifnet *ifp, struct buf_ring *br)
625 {
626 #ifdef ALTQ
627 	struct mbuf *m;
628 
629 	if (ALTQ_IS_ENABLED(&ifp->if_snd)) {
630 		IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
631 		return (m);
632 	}
633 #endif
634 	return (buf_ring_dequeue_sc(br));
635 }
636 
637 static __inline struct mbuf *
638 drbr_dequeue_cond(struct ifnet *ifp, struct buf_ring *br,
639     int (*func) (struct mbuf *, void *), void *arg)
640 {
641 	struct mbuf *m;
642 #ifdef ALTQ
643 	/*
644 	 * XXX need to evaluate / requeue
645 	 */
646 	if (ALTQ_IS_ENABLED(&ifp->if_snd)) {
647 		IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
648 		return (m);
649 	}
650 #endif
651 	m = buf_ring_peek(br);
652 	if (m == NULL || func(m, arg) == 0)
653 		return (NULL);
654 
655 	return (buf_ring_dequeue_sc(br));
656 }
657 
658 static __inline int
659 drbr_empty(struct ifnet *ifp, struct buf_ring *br)
660 {
661 #ifdef ALTQ
662 	if (ALTQ_IS_ENABLED(&ifp->if_snd))
663 		return (IFQ_DRV_IS_EMPTY(&ifp->if_snd));
664 #endif
665 	return (buf_ring_empty(br));
666 }
667 
668 static __inline int
669 drbr_inuse(struct ifnet *ifp, struct buf_ring *br)
670 {
671 #ifdef ALTQ
672 	if (ALTQ_IS_ENABLED(&ifp->if_snd))
673 		return (ifp->if_snd.ifq_len);
674 #endif
675 	return (buf_ring_count(br));
676 }
677 #endif
678 /*
679  * 72 was chosen below because it is the size of a TCP/IP
680  * header (40) + the minimum mss (32).
681  */
682 #define	IF_MINMTU	72
683 #define	IF_MAXMTU	65535
684 
685 #endif /* _KERNEL */
686 
687 /*
688  * The ifaddr structure contains information about one address
689  * of an interface.  They are maintained by the different address families,
690  * are allocated and attached when an address is set, and are linked
691  * together so all addresses for an interface can be located.
692  *
693  * NOTE: a 'struct ifaddr' is always at the beginning of a larger
694  * chunk of malloc'ed memory, where we store the three addresses
695  * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
696  */
697 struct ifaddr {
698 	struct	sockaddr *ifa_addr;	/* address of interface */
699 	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
700 #define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
701 	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
702 	struct	if_data if_data;	/* not all members are meaningful */
703 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
704 	TAILQ_ENTRY(ifaddr) ifa_link;	/* queue macro glue */
705 	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
706 		(int, struct rtentry *, struct rt_addrinfo *);
707 	u_short	ifa_flags;		/* mostly rt_flags for cloning */
708 	u_int	ifa_refcnt;		/* references to this structure */
709 	int	ifa_metric;		/* cost of going out this interface */
710 	int (*ifa_claim_addr)		/* check if an addr goes to this if */
711 		(struct ifaddr *, struct sockaddr *);
712 	struct mtx ifa_mtx;
713 };
714 #define	IFA_ROUTE	RTF_UP		/* route installed */
715 
716 /* for compatibility with other BSDs */
717 #define	ifa_list	ifa_link
718 
719 #ifdef _KERNEL
720 #define	IFA_LOCK(ifa)		mtx_lock(&(ifa)->ifa_mtx)
721 #define	IFA_UNLOCK(ifa)		mtx_unlock(&(ifa)->ifa_mtx)
722 
723 void	ifa_free(struct ifaddr *ifa);
724 void	ifa_init(struct ifaddr *ifa);
725 void	ifa_ref(struct ifaddr *ifa);
726 #endif
727 
728 /*
729  * The prefix structure contains information about one prefix
730  * of an interface.  They are maintained by the different address families,
731  * are allocated and attached when a prefix or an address is set,
732  * and are linked together so all prefixes for an interface can be located.
733  */
734 struct ifprefix {
735 	struct	sockaddr *ifpr_prefix;	/* prefix of interface */
736 	struct	ifnet *ifpr_ifp;	/* back-pointer to interface */
737 	TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
738 	u_char	ifpr_plen;		/* prefix length in bits */
739 	u_char	ifpr_type;		/* protocol dependent prefix type */
740 };
741 
742 /*
743  * Multicast address structure.  This is analogous to the ifaddr
744  * structure except that it keeps track of multicast addresses.
745  */
746 struct ifmultiaddr {
747 	TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
748 	struct	sockaddr *ifma_addr; 	/* address this membership is for */
749 	struct	sockaddr *ifma_lladdr;	/* link-layer translation, if any */
750 	struct	ifnet *ifma_ifp;	/* back-pointer to interface */
751 	u_int	ifma_refcount;		/* reference count */
752 	void	*ifma_protospec;	/* protocol-specific state, if any */
753 	struct	ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
754 };
755 
756 #ifdef _KERNEL
757 
758 extern	struct rwlock ifnet_lock;
759 #define	IFNET_LOCK_INIT() \
760    rw_init_flags(&ifnet_lock, "ifnet",  RW_RECURSE)
761 #define	IFNET_WLOCK()		rw_wlock(&ifnet_lock)
762 #define	IFNET_WUNLOCK()		rw_wunlock(&ifnet_lock)
763 #define	IFNET_WLOCK_ASSERT()	rw_assert(&ifnet_lock, RA_LOCKED)
764 #define	IFNET_RLOCK()		rw_rlock(&ifnet_lock)
765 #define	IFNET_RUNLOCK()		rw_runlock(&ifnet_lock)
766 
767 /*
768  * Look up an ifnet given its index; the _ref variant also acquires a
769  * reference that must be freed using if_rele().  It is almost always a bug
770  * to call ifnet_byindex() instead if ifnet_byindex_ref().
771  */
772 struct ifnet	*ifnet_byindex(u_short idx);
773 struct ifnet	*ifnet_byindex_locked(u_short idx);
774 struct ifnet	*ifnet_byindex_ref(u_short idx);
775 
776 /*
777  * Given the index, ifaddr_byindex() returns the one and only
778  * link-level ifaddr for the interface. You are not supposed to use
779  * it to traverse the list of addresses associated to the interface.
780  */
781 struct ifaddr	*ifaddr_byindex(u_short idx);
782 
783 VNET_DECLARE(struct ifnethead, ifnet);
784 VNET_DECLARE(struct ifgrouphead, ifg_head);
785 VNET_DECLARE(int, if_index);
786 VNET_DECLARE(struct ifnet *, loif);	/* first loopback interface */
787 VNET_DECLARE(int, useloopback);
788 
789 #define	V_ifnet		VNET(ifnet)
790 #define	V_ifg_head	VNET(ifg_head)
791 #define	V_if_index	VNET(if_index)
792 #define	V_loif		VNET(loif)
793 #define	V_useloopback	VNET(useloopback)
794 
795 extern	int ifqmaxlen;
796 
797 int	if_addgroup(struct ifnet *, const char *);
798 int	if_delgroup(struct ifnet *, const char *);
799 int	if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
800 int	if_allmulti(struct ifnet *, int);
801 struct	ifnet* if_alloc(u_char);
802 void	if_attach(struct ifnet *);
803 void	if_dead(struct ifnet *);
804 void	if_grow(void);
805 int	if_delmulti(struct ifnet *, struct sockaddr *);
806 void	if_delmulti_ifma(struct ifmultiaddr *);
807 void	if_detach(struct ifnet *);
808 void	if_vmove(struct ifnet *, struct vnet *);
809 void	if_purgeaddrs(struct ifnet *);
810 void	if_purgemaddrs(struct ifnet *);
811 void	if_down(struct ifnet *);
812 struct ifmultiaddr *
813 	if_findmulti(struct ifnet *, struct sockaddr *);
814 void	if_free(struct ifnet *);
815 void	if_free_type(struct ifnet *, u_char);
816 void	if_initname(struct ifnet *, const char *, int);
817 void	if_link_state_change(struct ifnet *, int);
818 int	if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
819 void	if_qflush(struct ifnet *);
820 void	if_ref(struct ifnet *);
821 void	if_rele(struct ifnet *);
822 int	if_setlladdr(struct ifnet *, const u_char *, int);
823 void	if_up(struct ifnet *);
824 /*void	ifinit(void);*/ /* declared in systm.h for main() */
825 int	ifioctl(struct socket *, u_long, caddr_t, struct thread *);
826 int	ifpromisc(struct ifnet *, int);
827 struct	ifnet *ifunit(const char *);
828 struct	ifnet *ifunit_ref(const char *);
829 
830 void	ifq_init(struct ifaltq *, struct ifnet *ifp);
831 void	ifq_delete(struct ifaltq *);
832 
833 struct	ifaddr *ifa_ifwithaddr(struct sockaddr *);
834 int		ifa_ifwithaddr_check(struct sockaddr *);
835 struct	ifaddr *ifa_ifwithbroadaddr(struct sockaddr *);
836 struct	ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
837 struct	ifaddr *ifa_ifwithnet(struct sockaddr *);
838 struct	ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
839 struct	ifaddr *ifa_ifwithroute_fib(int, struct sockaddr *, struct sockaddr *, u_int);
840 
841 struct	ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
842 
843 int	if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
844 
845 typedef	void *if_com_alloc_t(u_char type, struct ifnet *ifp);
846 typedef	void if_com_free_t(void *com, u_char type);
847 void	if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
848 void	if_deregister_com_alloc(u_char type);
849 
850 #define IF_LLADDR(ifp)							\
851     LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr))
852 
853 #ifdef DEVICE_POLLING
854 enum poll_cmd {	POLL_ONLY, POLL_AND_CHECK_STATUS };
855 
856 typedef	int poll_handler_t(struct ifnet *ifp, enum poll_cmd cmd, int count);
857 int    ether_poll_register(poll_handler_t *h, struct ifnet *ifp);
858 int    ether_poll_deregister(struct ifnet *ifp);
859 #endif /* DEVICE_POLLING */
860 
861 #endif /* _KERNEL */
862 
863 #endif /* !_NET_IF_VAR_H_ */
864