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