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