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