ifq.h revision 83366
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 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by the University of
16 *	California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 *    may be used to endorse or promote products derived from this software
19 *    without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 *	From: @(#)if.h	8.1 (Berkeley) 6/10/93
34 * $FreeBSD: head/sys/net/if_var.h 83366 2001-09-12 08:38:13Z julian $
35 */
36
37#ifndef	_NET_IF_VAR_H_
38#define	_NET_IF_VAR_H_
39
40/*
41 * Structures defining a network interface, providing a packet
42 * transport mechanism (ala level 0 of the PUP protocols).
43 *
44 * Each interface accepts output datagrams of a specified maximum
45 * length, and provides higher level routines with input datagrams
46 * received from its medium.
47 *
48 * Output occurs when the routine if_output is called, with three parameters:
49 *	(*ifp->if_output)(ifp, m, dst, rt)
50 * Here m is the mbuf chain to be sent and dst is the destination address.
51 * The output routine encapsulates the supplied datagram if necessary,
52 * and then transmits it on its medium.
53 *
54 * On input, each interface unwraps the data received by it, and either
55 * places it on the input queue of a internetwork datagram routine
56 * and posts the associated software interrupt, or passes the datagram to a raw
57 * packet input routine.
58 *
59 * Routines exist for locating interfaces by their addresses
60 * or for locating a interface on a certain network, as well as more general
61 * routing and gateway routines maintaining information used to locate
62 * interfaces.  These routines live in the files if.c and route.c
63 */
64
65#ifdef __STDC__
66/*
67 * Forward structure declarations for function prototypes [sic].
68 */
69struct	mbuf;
70struct	thread;
71struct	rtentry;
72struct	socket;
73struct	ether_header;
74#endif
75
76#include <sys/queue.h>		/* get TAILQ macros */
77
78#ifdef _KERNEL
79#include <sys/mbuf.h>
80#include <sys/systm.h>		/* XXX */
81#endif /* _KERNEL */
82#include <sys/lock.h>		/* XXX */
83#include <sys/mutex.h>		/* XXX */
84#include <sys/event.h>		/* XXX */
85
86TAILQ_HEAD(ifnethead, ifnet);	/* we use TAILQs so that the order of */
87TAILQ_HEAD(ifaddrhead, ifaddr);	/* instantiation is preserved in the list */
88TAILQ_HEAD(ifprefixhead, ifprefix);
89TAILQ_HEAD(ifmultihead, ifmultiaddr);
90
91/*
92 * Structure defining a queue for a network interface.
93 */
94struct	ifqueue {
95	struct	mbuf *ifq_head;
96	struct	mbuf *ifq_tail;
97	int	ifq_len;
98	int	ifq_maxlen;
99	int	ifq_drops;
100	struct	mtx ifq_mtx;
101};
102
103/*
104 * Structure defining a network interface.
105 *
106 * (Would like to call this struct ``if'', but C isn't PL/1.)
107 */
108struct ifnet {
109	void	*if_softc;		/* pointer to driver state */
110	char	*if_name;		/* name, e.g. ``en'' or ``lo'' */
111	TAILQ_ENTRY(ifnet) if_link; 	/* all struct ifnets are chained */
112	struct	ifaddrhead if_addrhead;	/* linked list of addresses per if */
113	struct	klist if_klist;		/* events attached to this if */
114	int	if_pcount;		/* number of promiscuous listeners */
115	struct	bpf_if *if_bpf;		/* packet filter structure */
116	u_short	if_index;		/* numeric abbreviation for this if  */
117	short	if_unit;		/* sub-unit for lower level driver */
118	short	if_timer;		/* time 'til if_watchdog called */
119	short	if_flags;		/* up/down, broadcast, etc. */
120	int	if_mpsafe;		/* XXX TEMPORARY */
121	int	if_ipending;		/* interrupts pending */
122	void	*if_linkmib;		/* link-type-specific MIB data */
123	size_t	if_linkmiblen;		/* length of above data */
124	struct	if_data if_data;
125	struct	ifmultihead if_multiaddrs; /* multicast addresses configured */
126	int	if_amcount;		/* number of all-multicast requests */
127/* procedure handles */
128	int	(*if_output)		/* output routine (enqueue) */
129		__P((struct ifnet *, struct mbuf *, struct sockaddr *,
130		     struct rtentry *));
131	void	(*if_start)		/* initiate output routine */
132		__P((struct ifnet *));
133	int	(*if_done)		/* output complete routine */
134		__P((struct ifnet *));	/* (XXX not used; fake prototype) */
135	int	(*if_ioctl)		/* ioctl routine */
136		__P((struct ifnet *, u_long, caddr_t));
137	void	(*if_watchdog)		/* timer routine */
138		__P((struct ifnet *));
139	int	(*if_poll_recv)		/* polled receive routine */
140		__P((struct ifnet *, int *));
141	int	(*if_poll_xmit)		/* polled transmit routine */
142		__P((struct ifnet *, int *));
143	void	(*if_poll_intren)	/* polled interrupt reenable routine */
144		__P((struct ifnet *));
145	void	(*if_poll_slowinput)	/* input routine for slow devices */
146		__P((struct ifnet *, struct mbuf *));
147	void	(*if_init)		/* Init routine */
148		__P((void *));
149	int	(*if_resolvemulti)	/* validate/resolve multicast */
150		__P((struct ifnet *, struct sockaddr **, struct sockaddr *));
151	struct	ifqueue if_snd;		/* output queue */
152	struct	ifqueue *if_poll_slowq;	/* input queue for slow devices */
153	struct	ifprefixhead if_prefixhead; /* list of prefixes per if */
154};
155
156typedef void if_init_f_t __P((void *));
157
158#define	if_mtu		if_data.ifi_mtu
159#define	if_type		if_data.ifi_type
160#define if_physical	if_data.ifi_physical
161#define	if_addrlen	if_data.ifi_addrlen
162#define	if_hdrlen	if_data.ifi_hdrlen
163#define	if_metric	if_data.ifi_metric
164#define	if_baudrate	if_data.ifi_baudrate
165#define	if_hwassist	if_data.ifi_hwassist
166#define	if_ipackets	if_data.ifi_ipackets
167#define	if_ierrors	if_data.ifi_ierrors
168#define	if_opackets	if_data.ifi_opackets
169#define	if_oerrors	if_data.ifi_oerrors
170#define	if_collisions	if_data.ifi_collisions
171#define	if_ibytes	if_data.ifi_ibytes
172#define	if_obytes	if_data.ifi_obytes
173#define	if_imcasts	if_data.ifi_imcasts
174#define	if_omcasts	if_data.ifi_omcasts
175#define	if_iqdrops	if_data.ifi_iqdrops
176#define	if_noproto	if_data.ifi_noproto
177#define	if_lastchange	if_data.ifi_lastchange
178#define if_recvquota	if_data.ifi_recvquota
179#define	if_xmitquota	if_data.ifi_xmitquota
180#define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0)
181
182/* for compatibility with other BSDs */
183#define	if_addrlist	if_addrhead
184#define	if_list		if_link
185
186/*
187 * Bit values in if_ipending
188 */
189#define	IFI_RECV	1	/* I want to receive */
190#define	IFI_XMIT	2	/* I want to transmit */
191
192/*
193 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
194 * are queues of messages stored on ifqueue structures
195 * (defined above).  Entries are added to and deleted from these structures
196 * by these macros, which should be called with ipl raised to splimp().
197 */
198#define IF_LOCK(ifq)		mtx_lock(&(ifq)->ifq_mtx)
199#define IF_UNLOCK(ifq)		mtx_unlock(&(ifq)->ifq_mtx)
200#define	_IF_QFULL(ifq)		((ifq)->ifq_len >= (ifq)->ifq_maxlen)
201#define	_IF_DROP(ifq)		((ifq)->ifq_drops++)
202#define	_IF_QLEN(ifq)		((ifq)->ifq_len)
203
204#define	_IF_ENQUEUE(ifq, m) do { 				\
205	(m)->m_nextpkt = NULL;					\
206	if ((ifq)->ifq_tail == NULL) 				\
207		(ifq)->ifq_head = m; 				\
208	else 							\
209		(ifq)->ifq_tail->m_nextpkt = m; 		\
210	(ifq)->ifq_tail = m; 					\
211	(ifq)->ifq_len++; 					\
212} while (0)
213
214#define IF_ENQUEUE(ifq, m) do {					\
215	IF_LOCK(ifq); 						\
216	_IF_ENQUEUE(ifq, m); 					\
217	IF_UNLOCK(ifq); 					\
218} while (0)
219
220#define	_IF_PREPEND(ifq, m) do {				\
221	(m)->m_nextpkt = (ifq)->ifq_head; 			\
222	if ((ifq)->ifq_tail == NULL) 				\
223		(ifq)->ifq_tail = (m); 				\
224	(ifq)->ifq_head = (m); 					\
225	(ifq)->ifq_len++; 					\
226} while (0)
227
228#define IF_PREPEND(ifq, m) do {		 			\
229	IF_LOCK(ifq); 						\
230	_IF_PREPEND(ifq, m); 					\
231	IF_UNLOCK(ifq); 					\
232} while (0)
233
234#define	_IF_DEQUEUE(ifq, m) do { 				\
235	(m) = (ifq)->ifq_head; 					\
236	if (m) { 						\
237		if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) 	\
238			(ifq)->ifq_tail = NULL; 		\
239		(m)->m_nextpkt = NULL; 				\
240		(ifq)->ifq_len--; 				\
241	} 							\
242} while (0)
243
244#define IF_DEQUEUE(ifq, m) do { 				\
245	IF_LOCK(ifq); 						\
246	_IF_DEQUEUE(ifq, m); 					\
247	IF_UNLOCK(ifq); 					\
248} while (0)
249
250#define IF_DRAIN(ifq) do { 					\
251	struct mbuf *m; 					\
252	IF_LOCK(ifq); 						\
253	for (;;) { 						\
254		_IF_DEQUEUE(ifq, m); 				\
255		if (m == NULL) 					\
256			break; 					\
257		m_freem(m); 					\
258	} 							\
259	IF_UNLOCK(ifq); 					\
260} while (0)
261
262#ifdef _KERNEL
263#define	IF_HANDOFF(ifq, m, ifp)			if_handoff(ifq, m, ifp, 0)
264#define	IF_HANDOFF_ADJ(ifq, m, ifp, adj)	if_handoff(ifq, m, ifp, adj)
265
266static __inline int
267if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp, int adjust)
268{
269	int active = 0;
270
271	IF_LOCK(ifq);
272	if (_IF_QFULL(ifq)) {
273		_IF_DROP(ifq);
274		IF_UNLOCK(ifq);
275		m_freem(m);
276		return (0);
277	}
278	if (ifp != NULL) {
279		ifp->if_obytes += m->m_pkthdr.len + adjust;
280		if (m->m_flags & M_MCAST)
281			ifp->if_omcasts++;
282		active = ifp->if_flags & IFF_OACTIVE;
283	}
284	_IF_ENQUEUE(ifq, m);
285	IF_UNLOCK(ifq);
286	if (ifp != NULL && !active) {
287		if (ifp->if_mpsafe) {
288			DROP_GIANT_NOSWITCH();
289			(*ifp->if_start)(ifp);
290			PICKUP_GIANT();
291		} else {
292			(*ifp->if_start)(ifp);
293		}
294	}
295	return (1);
296}
297
298/*
299 * 72 was chosen below because it is the size of a TCP/IP
300 * header (40) + the minimum mss (32).
301 */
302#define	IF_MINMTU	72
303#define	IF_MAXMTU	65535
304
305#endif /* _KERNEL */
306
307/*
308 * The ifaddr structure contains information about one address
309 * of an interface.  They are maintained by the different address families,
310 * are allocated and attached when an address is set, and are linked
311 * together so all addresses for an interface can be located.
312 */
313struct ifaddr {
314	struct	sockaddr *ifa_addr;	/* address of interface */
315	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
316#define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
317	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
318	struct	if_data if_data;	/* not all members are meaningful */
319	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
320	TAILQ_ENTRY(ifaddr) ifa_link;	/* queue macro glue */
321	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
322		__P((int, struct rtentry *, struct sockaddr *));
323	u_short	ifa_flags;		/* mostly rt_flags for cloning */
324	u_int	ifa_refcnt;		/* references to this structure */
325	int	ifa_metric;		/* cost of going out this interface */
326#ifdef notdef
327	struct	rtentry *ifa_rt;	/* XXXX for ROUTETOIF ????? */
328#endif
329	int (*ifa_claim_addr)		/* check if an addr goes to this if */
330		__P((struct ifaddr *, struct sockaddr *));
331
332};
333#define	IFA_ROUTE	RTF_UP		/* route installed */
334
335/* for compatibility with other BSDs */
336#define	ifa_list	ifa_link
337
338/*
339 * The prefix structure contains information about one prefix
340 * of an interface.  They are maintained by the different address families,
341 * are allocated and attached when an prefix or an address is set,
342 * and are linked together so all prefixes for an interface can be located.
343 */
344struct ifprefix {
345	struct	sockaddr *ifpr_prefix;	/* prefix of interface */
346	struct	ifnet *ifpr_ifp;	/* back-pointer to interface */
347	TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
348	u_char	ifpr_plen;		/* prefix length in bits */
349	u_char	ifpr_type;		/* protocol dependent prefix type */
350};
351
352/*
353 * Multicast address structure.  This is analogous to the ifaddr
354 * structure except that it keeps track of multicast addresses.
355 * Also, the reference count here is a count of requests for this
356 * address, not a count of pointers to this structure.
357 */
358struct ifmultiaddr {
359	TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
360	struct	sockaddr *ifma_addr; 	/* address this membership is for */
361	struct	sockaddr *ifma_lladdr;	/* link-layer translation, if any */
362	struct	ifnet *ifma_ifp;	/* back-pointer to interface */
363	u_int	ifma_refcount;		/* reference count */
364	void	*ifma_protospec;	/* protocol-specific state, if any */
365};
366
367#ifdef _KERNEL
368#define	IFAFREE(ifa) \
369	do { \
370		if ((ifa)->ifa_refcnt <= 0) \
371			ifafree(ifa); \
372		else \
373			(ifa)->ifa_refcnt--; \
374	} while (0)
375
376struct ifindex_entry {
377	struct 	ifnet *ife_ifnet;
378	struct	ifaddr *ife_ifnet_addr;
379	dev_t	ife_dev;
380};
381
382#define ifnet_byindex(idx)	ifindex_table[(idx)].ife_ifnet
383#define ifaddr_byindex(idx)	ifindex_table[(idx)].ife_ifnet_addr
384#define ifdev_byindex(idx)	ifindex_table[(idx)].ife_dev
385
386extern	struct ifnethead ifnet;
387extern	struct ifindex_entry *ifindex_table;
388extern	int ifqmaxlen;
389extern	struct ifnet *loif;	/* first loopback interface */
390extern	int if_index;
391
392void	ether_ifattach __P((struct ifnet *, int));
393void	ether_ifdetach __P((struct ifnet *, int));
394void	ether_input __P((struct ifnet *, struct ether_header *, struct mbuf *));
395void	ether_demux __P((struct ifnet *, struct ether_header *, struct mbuf *));
396int	ether_output __P((struct ifnet *,
397	   struct mbuf *, struct sockaddr *, struct rtentry *));
398int	ether_output_frame __P((struct ifnet *, struct mbuf *));
399int	ether_ioctl __P((struct ifnet *, int, caddr_t));
400
401int	if_addmulti __P((struct ifnet *, struct sockaddr *,
402			 struct ifmultiaddr **));
403int	if_allmulti __P((struct ifnet *, int));
404void	if_attach __P((struct ifnet *));
405int	if_delmulti __P((struct ifnet *, struct sockaddr *));
406void	if_detach __P((struct ifnet *));
407void	if_down __P((struct ifnet *));
408void	if_route __P((struct ifnet *, int flag, int fam));
409int	if_setlladdr __P((struct ifnet *, const u_char *, int));
410void	if_unroute __P((struct ifnet *, int flag, int fam));
411void	if_up __P((struct ifnet *));
412/*void	ifinit __P((void));*/ /* declared in systm.h for main() */
413int	ifioctl __P((struct socket *, u_long, caddr_t, struct thread *));
414int	ifpromisc __P((struct ifnet *, int));
415struct	ifnet *ifunit __P((const char *));
416struct	ifnet *if_withname __P((struct sockaddr *));
417
418int	if_poll_recv_slow __P((struct ifnet *ifp, int *quotap));
419void	if_poll_xmit_slow __P((struct ifnet *ifp, int *quotap));
420void	if_poll_throttle __P((void));
421void	if_poll_unthrottle __P((void *));
422void	if_poll_init __P((void));
423void	if_poll __P((void));
424
425struct	ifaddr *ifa_ifwithaddr __P((struct sockaddr *));
426struct	ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *));
427struct	ifaddr *ifa_ifwithnet __P((struct sockaddr *));
428struct	ifaddr *ifa_ifwithroute __P((int, struct sockaddr *,
429					struct sockaddr *));
430struct	ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *));
431void	ifafree __P((struct ifaddr *));
432
433struct	ifmultiaddr *ifmaof_ifpforaddr __P((struct sockaddr *,
434					    struct ifnet *));
435int	if_simloop __P((struct ifnet *ifp, struct mbuf *m, int af, int hlen));
436
437void	if_clone_attach __P((struct if_clone *));
438void	if_clone_detach __P((struct if_clone *));
439
440int	if_clone_create __P((char *, int));
441int	if_clone_destroy __P((const char *));
442
443#endif /* _KERNEL */
444
445#endif /* !_NET_IF_VAR_H_ */
446