xref: /freebsd/sys/net/if_var.h (revision 271c3a9060f2ee55607ebe146523f888e1db2654)
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 #endif
74 
75 #include <sys/queue.h>		/* get TAILQ macros */
76 
77 #ifdef _KERNEL
78 #include <sys/mbuf.h>
79 #include <sys/eventhandler.h>
80 #endif /* _KERNEL */
81 #include <sys/lock.h>		/* XXX */
82 #include <sys/mutex.h>		/* XXX */
83 #include <sys/event.h>		/* XXX */
84 #include <sys/_task.h>
85 
86 #define	IF_DUNIT_NONE	-1
87 
88 #include <altq/if_altq.h>
89 
90 TAILQ_HEAD(ifnethead, ifnet);	/* we use TAILQs so that the order of */
91 TAILQ_HEAD(ifaddrhead, ifaddr);	/* instantiation is preserved in the list */
92 TAILQ_HEAD(ifprefixhead, ifprefix);
93 TAILQ_HEAD(ifmultihead, ifmultiaddr);
94 TAILQ_HEAD(ifgrouphead, ifg_group);
95 
96 /*
97  * Structure defining a queue for a network interface.
98  */
99 struct	ifqueue {
100 	struct	mbuf *ifq_head;
101 	struct	mbuf *ifq_tail;
102 	int	ifq_len;
103 	int	ifq_maxlen;
104 	int	ifq_drops;
105 	struct	mtx ifq_mtx;
106 };
107 
108 /*
109  * Structure defining a network interface.
110  *
111  * (Would like to call this struct ``if'', but C isn't PL/1.)
112  */
113 
114 struct ifnet {
115 	void	*if_softc;		/* pointer to driver state */
116 	void	*if_l2com;		/* pointer to protocol bits */
117 	TAILQ_ENTRY(ifnet) if_link; 	/* all struct ifnets are chained */
118 	char	if_xname[IFNAMSIZ];	/* external name (name + unit) */
119 	const char *if_dname;		/* driver name */
120 	int	if_dunit;		/* unit or IF_DUNIT_NONE */
121 	struct	ifaddrhead if_addrhead;	/* linked list of addresses per if */
122 		/*
123 		 * if_addrhead is the list of all addresses associated to
124 		 * an interface.
125 		 * Some code in the kernel assumes that first element
126 		 * of the list has type AF_LINK, and contains sockaddr_dl
127 		 * addresses which store the link-level address and the name
128 		 * of the interface.
129 		 * However, access to the AF_LINK address through this
130 		 * field is deprecated. Use if_addr or ifaddr_byindex() instead.
131 		 */
132 	struct	knlist if_klist;	/* events attached to this if */
133 	int	if_pcount;		/* number of promiscuous listeners */
134 	struct	carp_if *if_carp;	/* carp interface structure */
135 	struct	bpf_if *if_bpf;		/* packet filter structure */
136 	u_short	if_index;		/* numeric abbreviation for this if  */
137 	short	if_timer;		/* time 'til if_watchdog called */
138 	struct  ifvlantrunk *if_vlantrunk; /* pointer to 802.1q data */
139 	int	if_flags;		/* up/down, broadcast, etc. */
140 	int	if_capabilities;	/* interface features & capabilities */
141 	int	if_capenable;		/* enabled features & capabilities */
142 	void	*if_linkmib;		/* link-type-specific MIB data */
143 	size_t	if_linkmiblen;		/* length of above data */
144 	struct	if_data if_data;
145 	struct	ifmultihead if_multiaddrs; /* multicast addresses configured */
146 	int	if_amcount;		/* number of all-multicast requests */
147 /* procedure handles */
148 	int	(*if_output)		/* output routine (enqueue) */
149 		(struct ifnet *, struct mbuf *, struct sockaddr *,
150 		     struct rtentry *);
151 	void	(*if_input)		/* input routine (from h/w driver) */
152 		(struct ifnet *, struct mbuf *);
153 	void	(*if_start)		/* initiate output routine */
154 		(struct ifnet *);
155 	int	(*if_ioctl)		/* ioctl routine */
156 		(struct ifnet *, u_long, caddr_t);
157 	void	(*if_watchdog)		/* timer routine */
158 		(struct ifnet *);
159 	void	(*if_init)		/* Init routine */
160 		(void *);
161 	int	(*if_resolvemulti)	/* validate/resolve multicast */
162 		(struct ifnet *, struct sockaddr **, struct sockaddr *);
163 	struct	ifaddr	*if_addr;	/* pointer to link-level address */
164 	void	*if_llsoftc;		/* link layer softc */
165 	int	if_drv_flags;		/* driver-managed status flags */
166 	u_int	if_spare_flags2;	/* spare flags 2 */
167 	struct  ifaltq if_snd;		/* output queue (includes altq) */
168 	const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
169 
170 	void	*if_bridge;		/* bridge glue */
171 
172 	struct	lltable *lltables;	/* list of L3-L2 resolution tables */
173 
174 	struct	label *if_label;	/* interface MAC label */
175 
176 	/* these are only used by IPv6 */
177 	struct	ifprefixhead if_prefixhead; /* list of prefixes per if */
178 	void	*if_afdata[AF_MAX];
179 	int	if_afdata_initialized;
180 	struct	mtx if_afdata_mtx;
181 	struct	task if_starttask;	/* task for IFF_NEEDSGIANT */
182 	struct	task if_linktask;	/* task for link change events */
183 	struct	mtx if_addr_mtx;	/* mutex to protect address lists */
184 	LIST_ENTRY(ifnet) if_clones;	/* interfaces of a cloner */
185 	TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
186 					/* protected by if_addr_mtx */
187 	void	*if_pf_kif;
188 	void	*if_lagg;		/* lagg glue */
189 	void	*if_pspare[10];		/* multiq/TOE 3; vimage 3; general use 4 */
190 	int	if_ispare[2];		/* general use 2 */
191 };
192 
193 typedef void if_init_f_t(void *);
194 
195 /*
196  * XXX These aliases are terribly dangerous because they could apply
197  * to anything.
198  */
199 #define	if_mtu		if_data.ifi_mtu
200 #define	if_type		if_data.ifi_type
201 #define if_physical	if_data.ifi_physical
202 #define	if_addrlen	if_data.ifi_addrlen
203 #define	if_hdrlen	if_data.ifi_hdrlen
204 #define	if_metric	if_data.ifi_metric
205 #define	if_link_state	if_data.ifi_link_state
206 #define	if_baudrate	if_data.ifi_baudrate
207 #define	if_hwassist	if_data.ifi_hwassist
208 #define	if_ipackets	if_data.ifi_ipackets
209 #define	if_ierrors	if_data.ifi_ierrors
210 #define	if_opackets	if_data.ifi_opackets
211 #define	if_oerrors	if_data.ifi_oerrors
212 #define	if_collisions	if_data.ifi_collisions
213 #define	if_ibytes	if_data.ifi_ibytes
214 #define	if_obytes	if_data.ifi_obytes
215 #define	if_imcasts	if_data.ifi_imcasts
216 #define	if_omcasts	if_data.ifi_omcasts
217 #define	if_iqdrops	if_data.ifi_iqdrops
218 #define	if_noproto	if_data.ifi_noproto
219 #define	if_lastchange	if_data.ifi_lastchange
220 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)NULL)
221 
222 /* for compatibility with other BSDs */
223 #define	if_addrlist	if_addrhead
224 #define	if_list		if_link
225 #define	if_name(ifp)	((ifp)->if_xname)
226 
227 /*
228  * Locks for address lists on the network interface.
229  */
230 #define	IF_ADDR_LOCK_INIT(if)	mtx_init(&(if)->if_addr_mtx,		\
231 				    "if_addr_mtx", NULL, MTX_DEF)
232 #define	IF_ADDR_LOCK_DESTROY(if)	mtx_destroy(&(if)->if_addr_mtx)
233 #define	IF_ADDR_LOCK(if)	mtx_lock(&(if)->if_addr_mtx)
234 #define	IF_ADDR_UNLOCK(if)	mtx_unlock(&(if)->if_addr_mtx)
235 #define	IF_ADDR_LOCK_ASSERT(if)	mtx_assert(&(if)->if_addr_mtx, MA_OWNED)
236 
237 /*
238  * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
239  * are queues of messages stored on ifqueue structures
240  * (defined above).  Entries are added to and deleted from these structures
241  * by these macros, which should be called with ipl raised to splimp().
242  */
243 #define IF_LOCK(ifq)		mtx_lock(&(ifq)->ifq_mtx)
244 #define IF_UNLOCK(ifq)		mtx_unlock(&(ifq)->ifq_mtx)
245 #define	IF_LOCK_ASSERT(ifq)	mtx_assert(&(ifq)->ifq_mtx, MA_OWNED)
246 #define	_IF_QFULL(ifq)		((ifq)->ifq_len >= (ifq)->ifq_maxlen)
247 #define	_IF_DROP(ifq)		((ifq)->ifq_drops++)
248 #define	_IF_QLEN(ifq)		((ifq)->ifq_len)
249 
250 #define	_IF_ENQUEUE(ifq, m) do { 				\
251 	(m)->m_nextpkt = NULL;					\
252 	if ((ifq)->ifq_tail == NULL) 				\
253 		(ifq)->ifq_head = m; 				\
254 	else 							\
255 		(ifq)->ifq_tail->m_nextpkt = m; 		\
256 	(ifq)->ifq_tail = m; 					\
257 	(ifq)->ifq_len++; 					\
258 } while (0)
259 
260 #define IF_ENQUEUE(ifq, m) do {					\
261 	IF_LOCK(ifq); 						\
262 	_IF_ENQUEUE(ifq, m); 					\
263 	IF_UNLOCK(ifq); 					\
264 } while (0)
265 
266 #define	_IF_PREPEND(ifq, m) do {				\
267 	(m)->m_nextpkt = (ifq)->ifq_head; 			\
268 	if ((ifq)->ifq_tail == NULL) 				\
269 		(ifq)->ifq_tail = (m); 				\
270 	(ifq)->ifq_head = (m); 					\
271 	(ifq)->ifq_len++; 					\
272 } while (0)
273 
274 #define IF_PREPEND(ifq, m) do {		 			\
275 	IF_LOCK(ifq); 						\
276 	_IF_PREPEND(ifq, m); 					\
277 	IF_UNLOCK(ifq); 					\
278 } while (0)
279 
280 #define	_IF_DEQUEUE(ifq, m) do { 				\
281 	(m) = (ifq)->ifq_head; 					\
282 	if (m) { 						\
283 		if (((ifq)->ifq_head = (m)->m_nextpkt) == NULL)	\
284 			(ifq)->ifq_tail = NULL; 		\
285 		(m)->m_nextpkt = NULL; 				\
286 		(ifq)->ifq_len--; 				\
287 	} 							\
288 } while (0)
289 
290 #define IF_DEQUEUE(ifq, m) do { 				\
291 	IF_LOCK(ifq); 						\
292 	_IF_DEQUEUE(ifq, m); 					\
293 	IF_UNLOCK(ifq); 					\
294 } while (0)
295 
296 #define	_IF_POLL(ifq, m)	((m) = (ifq)->ifq_head)
297 #define	IF_POLL(ifq, m)		_IF_POLL(ifq, m)
298 
299 #define _IF_DRAIN(ifq) do { 					\
300 	struct mbuf *m; 					\
301 	for (;;) { 						\
302 		_IF_DEQUEUE(ifq, m); 				\
303 		if (m == NULL) 					\
304 			break; 					\
305 		m_freem(m); 					\
306 	} 							\
307 } while (0)
308 
309 #define IF_DRAIN(ifq) do {					\
310 	IF_LOCK(ifq);						\
311 	_IF_DRAIN(ifq);						\
312 	IF_UNLOCK(ifq);						\
313 } while(0)
314 
315 #ifdef _KERNEL
316 /* interface address change event */
317 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
318 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
319 /* new interface arrival event */
320 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *);
321 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
322 /* interface departure event */
323 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *);
324 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
325 
326 /*
327  * interface groups
328  */
329 struct ifg_group {
330 	char				 ifg_group[IFNAMSIZ];
331 	u_int				 ifg_refcnt;
332 	void				*ifg_pf_kif;
333 	TAILQ_HEAD(, ifg_member)	 ifg_members;
334 	TAILQ_ENTRY(ifg_group)		 ifg_next;
335 };
336 
337 struct ifg_member {
338 	TAILQ_ENTRY(ifg_member)	 ifgm_next;
339 	struct ifnet		*ifgm_ifp;
340 };
341 
342 struct ifg_list {
343 	struct ifg_group	*ifgl_group;
344 	TAILQ_ENTRY(ifg_list)	 ifgl_next;
345 };
346 
347 /* group attach event */
348 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
349 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
350 /* group detach event */
351 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
352 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
353 /* group change event */
354 typedef void (*group_change_event_handler_t)(void *, const char *);
355 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
356 
357 #define	IF_AFDATA_LOCK_INIT(ifp)	\
358     mtx_init(&(ifp)->if_afdata_mtx, "if_afdata", NULL, MTX_DEF)
359 #define	IF_AFDATA_LOCK(ifp)	mtx_lock(&(ifp)->if_afdata_mtx)
360 #define	IF_AFDATA_TRYLOCK(ifp)	mtx_trylock(&(ifp)->if_afdata_mtx)
361 #define	IF_AFDATA_UNLOCK(ifp)	mtx_unlock(&(ifp)->if_afdata_mtx)
362 #define	IF_AFDATA_DESTROY(ifp)	mtx_destroy(&(ifp)->if_afdata_mtx)
363 
364 #define	IFF_LOCKGIANT(ifp) do {						\
365 	if ((ifp)->if_flags & IFF_NEEDSGIANT)				\
366 		mtx_lock(&Giant);					\
367 } while (0)
368 
369 #define	IFF_UNLOCKGIANT(ifp) do {					\
370 	if ((ifp)->if_flags & IFF_NEEDSGIANT)				\
371 		mtx_unlock(&Giant);					\
372 } while (0)
373 
374 int	if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp,
375 	    int adjust);
376 #define	IF_HANDOFF(ifq, m, ifp)			\
377 	if_handoff((struct ifqueue *)ifq, m, ifp, 0)
378 #define	IF_HANDOFF_ADJ(ifq, m, ifp, adj)	\
379 	if_handoff((struct ifqueue *)ifq, m, ifp, adj)
380 
381 void	if_start(struct ifnet *);
382 
383 #define	IFQ_ENQUEUE(ifq, m, err)					\
384 do {									\
385 	IF_LOCK(ifq);							\
386 	if (ALTQ_IS_ENABLED(ifq))					\
387 		ALTQ_ENQUEUE(ifq, m, NULL, err);			\
388 	else {								\
389 		if (_IF_QFULL(ifq)) {					\
390 			m_freem(m);					\
391 			(err) = ENOBUFS;				\
392 		} else {						\
393 			_IF_ENQUEUE(ifq, m);				\
394 			(err) = 0;					\
395 		}							\
396 	}								\
397 	if (err)							\
398 		(ifq)->ifq_drops++;					\
399 	IF_UNLOCK(ifq);							\
400 } while (0)
401 
402 #define	IFQ_DEQUEUE_NOLOCK(ifq, m)					\
403 do {									\
404 	if (TBR_IS_ENABLED(ifq))					\
405 		(m) = tbr_dequeue_ptr(ifq, ALTDQ_REMOVE);		\
406 	else if (ALTQ_IS_ENABLED(ifq))					\
407 		ALTQ_DEQUEUE(ifq, m);					\
408 	else								\
409 		_IF_DEQUEUE(ifq, m);					\
410 } while (0)
411 
412 #define	IFQ_DEQUEUE(ifq, m)						\
413 do {									\
414 	IF_LOCK(ifq);							\
415 	IFQ_DEQUEUE_NOLOCK(ifq, m);					\
416 	IF_UNLOCK(ifq);							\
417 } while (0)
418 
419 #define	IFQ_POLL_NOLOCK(ifq, m)						\
420 do {									\
421 	if (TBR_IS_ENABLED(ifq))					\
422 		(m) = tbr_dequeue_ptr(ifq, ALTDQ_POLL);			\
423 	else if (ALTQ_IS_ENABLED(ifq))					\
424 		ALTQ_POLL(ifq, m);					\
425 	else								\
426 		_IF_POLL(ifq, m);					\
427 } while (0)
428 
429 #define	IFQ_POLL(ifq, m)						\
430 do {									\
431 	IF_LOCK(ifq);							\
432 	IFQ_POLL_NOLOCK(ifq, m);					\
433 	IF_UNLOCK(ifq);							\
434 } while (0)
435 
436 #define	IFQ_PURGE_NOLOCK(ifq)						\
437 do {									\
438 	if (ALTQ_IS_ENABLED(ifq)) {					\
439 		ALTQ_PURGE(ifq);					\
440 	} else								\
441 		_IF_DRAIN(ifq);						\
442 } while (0)
443 
444 #define	IFQ_PURGE(ifq)							\
445 do {									\
446 	IF_LOCK(ifq);							\
447 	IFQ_PURGE_NOLOCK(ifq);						\
448 	IF_UNLOCK(ifq);							\
449 } while (0)
450 
451 #define	IFQ_SET_READY(ifq)						\
452 	do { ((ifq)->altq_flags |= ALTQF_READY); } while (0)
453 
454 #define	IFQ_LOCK(ifq)			IF_LOCK(ifq)
455 #define	IFQ_UNLOCK(ifq)			IF_UNLOCK(ifq)
456 #define	IFQ_LOCK_ASSERT(ifq)		IF_LOCK_ASSERT(ifq)
457 #define	IFQ_IS_EMPTY(ifq)		((ifq)->ifq_len == 0)
458 #define	IFQ_INC_LEN(ifq)		((ifq)->ifq_len++)
459 #define	IFQ_DEC_LEN(ifq)		(--(ifq)->ifq_len)
460 #define	IFQ_INC_DROPS(ifq)		((ifq)->ifq_drops++)
461 #define	IFQ_SET_MAXLEN(ifq, len)	((ifq)->ifq_maxlen = (len))
462 
463 /*
464  * The IFF_DRV_OACTIVE test should really occur in the device driver, not in
465  * the handoff logic, as that flag is locked by the device driver.
466  */
467 #define	IFQ_HANDOFF_ADJ(ifp, m, adj, err)				\
468 do {									\
469 	int len;							\
470 	short mflags;							\
471 									\
472 	len = (m)->m_pkthdr.len;					\
473 	mflags = (m)->m_flags;						\
474 	IFQ_ENQUEUE(&(ifp)->if_snd, m, err);				\
475 	if ((err) == 0) {						\
476 		(ifp)->if_obytes += len + (adj);			\
477 		if (mflags & M_MCAST)					\
478 			(ifp)->if_omcasts++;				\
479 		if (((ifp)->if_drv_flags & IFF_DRV_OACTIVE) == 0)	\
480 			if_start(ifp);					\
481 	}								\
482 } while (0)
483 
484 #define	IFQ_HANDOFF(ifp, m, err)					\
485 	IFQ_HANDOFF_ADJ(ifp, m, 0, err)
486 
487 #define	IFQ_DRV_DEQUEUE(ifq, m)						\
488 do {									\
489 	(m) = (ifq)->ifq_drv_head;					\
490 	if (m) {							\
491 		if (((ifq)->ifq_drv_head = (m)->m_nextpkt) == NULL)	\
492 			(ifq)->ifq_drv_tail = NULL;			\
493 		(m)->m_nextpkt = NULL;					\
494 		(ifq)->ifq_drv_len--;					\
495 	} else {							\
496 		IFQ_LOCK(ifq);						\
497 		IFQ_DEQUEUE_NOLOCK(ifq, m);				\
498 		while ((ifq)->ifq_drv_len < (ifq)->ifq_drv_maxlen) {	\
499 			struct mbuf *m0;				\
500 			IFQ_DEQUEUE_NOLOCK(ifq, m0);			\
501 			if (m0 == NULL)					\
502 				break;					\
503 			m0->m_nextpkt = NULL;				\
504 			if ((ifq)->ifq_drv_tail == NULL)		\
505 				(ifq)->ifq_drv_head = m0;		\
506 			else						\
507 				(ifq)->ifq_drv_tail->m_nextpkt = m0;	\
508 			(ifq)->ifq_drv_tail = m0;			\
509 			(ifq)->ifq_drv_len++;				\
510 		}							\
511 		IFQ_UNLOCK(ifq);					\
512 	}								\
513 } while (0)
514 
515 #define	IFQ_DRV_PREPEND(ifq, m)						\
516 do {									\
517 	(m)->m_nextpkt = (ifq)->ifq_drv_head;				\
518 	if ((ifq)->ifq_drv_tail == NULL)				\
519 		(ifq)->ifq_drv_tail = (m);				\
520 	(ifq)->ifq_drv_head = (m);					\
521 	(ifq)->ifq_drv_len++;						\
522 } while (0)
523 
524 #define	IFQ_DRV_IS_EMPTY(ifq)						\
525 	(((ifq)->ifq_drv_len == 0) && ((ifq)->ifq_len == 0))
526 
527 #define	IFQ_DRV_PURGE(ifq)						\
528 do {									\
529 	struct mbuf *m, *n = (ifq)->ifq_drv_head;			\
530 	while((m = n) != NULL) {					\
531 		n = m->m_nextpkt;					\
532 		m_freem(m);						\
533 	}								\
534 	(ifq)->ifq_drv_head = (ifq)->ifq_drv_tail = NULL;		\
535 	(ifq)->ifq_drv_len = 0;						\
536 	IFQ_PURGE(ifq);							\
537 } while (0)
538 
539 /*
540  * 72 was chosen below because it is the size of a TCP/IP
541  * header (40) + the minimum mss (32).
542  */
543 #define	IF_MINMTU	72
544 #define	IF_MAXMTU	65535
545 
546 #endif /* _KERNEL */
547 
548 /*
549  * The ifaddr structure contains information about one address
550  * of an interface.  They are maintained by the different address families,
551  * are allocated and attached when an address is set, and are linked
552  * together so all addresses for an interface can be located.
553  *
554  * NOTE: a 'struct ifaddr' is always at the beginning of a larger
555  * chunk of malloc'ed memory, where we store the three addresses
556  * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
557  */
558 struct ifaddr {
559 	struct	sockaddr *ifa_addr;	/* address of interface */
560 	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
561 #define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
562 	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
563 	struct	if_data if_data;	/* not all members are meaningful */
564 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
565 	TAILQ_ENTRY(ifaddr) ifa_link;	/* queue macro glue */
566 	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
567 		(int, struct rtentry *, struct rt_addrinfo *);
568 	u_short	ifa_flags;		/* mostly rt_flags for cloning */
569 	u_int	ifa_refcnt;		/* references to this structure */
570 	int	ifa_metric;		/* cost of going out this interface */
571 	int (*ifa_claim_addr)		/* check if an addr goes to this if */
572 		(struct ifaddr *, struct sockaddr *);
573 	struct mtx ifa_mtx;
574 };
575 #define	IFA_ROUTE	RTF_UP		/* route installed */
576 
577 /* for compatibility with other BSDs */
578 #define	ifa_list	ifa_link
579 
580 #define	IFA_LOCK_INIT(ifa)	\
581     mtx_init(&(ifa)->ifa_mtx, "ifaddr", NULL, MTX_DEF)
582 #define	IFA_LOCK(ifa)		mtx_lock(&(ifa)->ifa_mtx)
583 #define	IFA_UNLOCK(ifa)		mtx_unlock(&(ifa)->ifa_mtx)
584 #define	IFA_DESTROY(ifa)	mtx_destroy(&(ifa)->ifa_mtx)
585 
586 /*
587  * The prefix structure contains information about one prefix
588  * of an interface.  They are maintained by the different address families,
589  * are allocated and attached when a prefix or an address is set,
590  * and are linked together so all prefixes for an interface can be located.
591  */
592 struct ifprefix {
593 	struct	sockaddr *ifpr_prefix;	/* prefix of interface */
594 	struct	ifnet *ifpr_ifp;	/* back-pointer to interface */
595 	TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
596 	u_char	ifpr_plen;		/* prefix length in bits */
597 	u_char	ifpr_type;		/* protocol dependent prefix type */
598 };
599 
600 /*
601  * Multicast address structure.  This is analogous to the ifaddr
602  * structure except that it keeps track of multicast addresses.
603  */
604 struct ifmultiaddr {
605 	TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
606 	struct	sockaddr *ifma_addr; 	/* address this membership is for */
607 	struct	sockaddr *ifma_lladdr;	/* link-layer translation, if any */
608 	struct	ifnet *ifma_ifp;	/* back-pointer to interface */
609 	u_int	ifma_refcount;		/* reference count */
610 	void	*ifma_protospec;	/* protocol-specific state, if any */
611 	struct	ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
612 };
613 
614 #ifdef _KERNEL
615 #define	IFAFREE(ifa)					\
616 	do {						\
617 		IFA_LOCK(ifa);				\
618 		KASSERT((ifa)->ifa_refcnt > 0,		\
619 		    ("ifa %p !(ifa_refcnt > 0)", ifa));	\
620 		if (--(ifa)->ifa_refcnt == 0) {		\
621 			IFA_DESTROY(ifa);		\
622 			free(ifa, M_IFADDR);		\
623 		} else 					\
624 			IFA_UNLOCK(ifa);		\
625 	} while (0)
626 
627 #define IFAREF(ifa)					\
628 	do {						\
629 		IFA_LOCK(ifa);				\
630 		++(ifa)->ifa_refcnt;			\
631 		IFA_UNLOCK(ifa);			\
632 	} while (0)
633 
634 extern	struct mtx ifnet_lock;
635 #define	IFNET_LOCK_INIT() \
636     mtx_init(&ifnet_lock, "ifnet", NULL, MTX_DEF | MTX_RECURSE)
637 #define	IFNET_WLOCK()		mtx_lock(&ifnet_lock)
638 #define	IFNET_WUNLOCK()		mtx_unlock(&ifnet_lock)
639 #define	IFNET_WLOCK_ASSERT()	mtx_assert(&ifnet_lock, MA_OWNED)
640 #define	IFNET_RLOCK()		IFNET_WLOCK()
641 #define	IFNET_RUNLOCK()		IFNET_WUNLOCK()
642 
643 struct ifindex_entry {
644 	struct	ifnet *ife_ifnet;
645 	struct cdev *ife_dev;
646 };
647 
648 struct ifnet	*ifnet_byindex(u_short idx);
649 
650 /*
651  * Given the index, ifaddr_byindex() returns the one and only
652  * link-level ifaddr for the interface. You are not supposed to use
653  * it to traverse the list of addresses associated to the interface.
654  */
655 struct ifaddr	*ifaddr_byindex(u_short idx);
656 struct cdev	*ifdev_byindex(u_short idx);
657 
658 extern	struct ifnethead ifnet;
659 extern	int ifqmaxlen;
660 extern	struct ifnet *loif;	/* first loopback interface */
661 extern	int if_index;
662 
663 int	if_addgroup(struct ifnet *, const char *);
664 int	if_delgroup(struct ifnet *, const char *);
665 int	if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
666 int	if_allmulti(struct ifnet *, int);
667 struct	ifnet* if_alloc(u_char);
668 void	if_attach(struct ifnet *);
669 int	if_delmulti(struct ifnet *, struct sockaddr *);
670 void	if_delmulti_ifma(struct ifmultiaddr *);
671 void	if_detach(struct ifnet *);
672 void	if_purgeaddrs(struct ifnet *);
673 void	if_purgemaddrs(struct ifnet *);
674 void	if_down(struct ifnet *);
675 struct ifmultiaddr *
676 	if_findmulti(struct ifnet *, struct sockaddr *);
677 void	if_free(struct ifnet *);
678 void	if_free_type(struct ifnet *, u_char);
679 void	if_initname(struct ifnet *, const char *, int);
680 void	if_link_state_change(struct ifnet *, int);
681 int	if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
682 int	if_setlladdr(struct ifnet *, const u_char *, int);
683 void	if_up(struct ifnet *);
684 /*void	ifinit(void);*/ /* declared in systm.h for main() */
685 int	ifioctl(struct socket *, u_long, caddr_t, struct thread *);
686 int	ifpromisc(struct ifnet *, int);
687 struct	ifnet *ifunit(const char *);
688 
689 struct	ifaddr *ifa_ifwithaddr(struct sockaddr *);
690 struct	ifaddr *ifa_ifwithbroadaddr(struct sockaddr *);
691 struct	ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
692 struct	ifaddr *ifa_ifwithnet(struct sockaddr *);
693 struct	ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
694 struct	ifaddr *ifa_ifwithroute_fib(int, struct sockaddr *, struct sockaddr *, u_int);
695 
696 struct	ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
697 
698 int	if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
699 
700 typedef	void *if_com_alloc_t(u_char type, struct ifnet *ifp);
701 typedef	void if_com_free_t(void *com, u_char type);
702 void	if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
703 void	if_deregister_com_alloc(u_char type);
704 
705 #define IF_LLADDR(ifp)							\
706     LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr))
707 
708 #ifdef DEVICE_POLLING
709 enum poll_cmd {	POLL_ONLY, POLL_AND_CHECK_STATUS };
710 
711 typedef	void poll_handler_t(struct ifnet *ifp, enum poll_cmd cmd, int count);
712 int    ether_poll_register(poll_handler_t *h, struct ifnet *ifp);
713 int    ether_poll_deregister(struct ifnet *ifp);
714 #endif /* DEVICE_POLLING */
715 
716 #endif /* _KERNEL */
717 
718 #endif /* !_NET_IF_VAR_H_ */
719