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