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