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