xref: /freebsd/sys/net/if_var.h (revision 61afd5bb22d787b0641523e7b9b95c964d669bd5)
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  *	$Id: if.h,v 1.41 1996/12/13 21:28:37 wollman Exp $
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  */
69 struct	mbuf;
70 struct	proc;
71 struct	rtentry;
72 struct	socket;
73 struct	ether_header;
74 #endif
75 
76 #include <sys/queue.h>		/* get TAILQ macros */
77 
78 TAILQ_HEAD(ifnethead, ifnet);	/* we use TAILQs so that the order of */
79 TAILQ_HEAD(ifaddrhead, ifaddr);	/* instantiation is preserved in the list */
80 
81 /*
82  * Structure defining a queue for a network interface.
83  */
84 struct	ifqueue {
85 	struct	mbuf *ifq_head;
86 	struct	mbuf *ifq_tail;
87 	int	ifq_len;
88 	int	ifq_maxlen;
89 	int	ifq_drops;
90 };
91 
92 /*
93  * Structure defining a network interface.
94  *
95  * (Would like to call this struct ``if'', but C isn't PL/1.)
96  */
97 struct ifnet {
98 	void	*if_softc;		/* pointer to driver state */
99 	char	*if_name;		/* name, e.g. ``en'' or ``lo'' */
100 	TAILQ_ENTRY(ifnet) if_link; 	/* all struct ifnets are chained */
101 	struct	ifaddrhead if_addrhead;	/* linked list of addresses per if */
102         int	if_pcount;		/* number of promiscuous listeners */
103 	struct	bpf_if *if_bpf;		/* packet filter structure */
104 	u_short	if_index;		/* numeric abbreviation for this if  */
105 	short	if_unit;		/* sub-unit for lower level driver */
106 	short	if_timer;		/* time 'til if_watchdog called */
107 	short	if_flags;		/* up/down, broadcast, etc. */
108 	int	if_ipending;		/* interrupts pending */
109 	void	*if_linkmib;		/* link-type-specific MIB data */
110 	size_t	if_linkmiblen;		/* length of above data */
111 	struct	if_data if_data;
112 /* procedure handles */
113 	int	(*if_output)		/* output routine (enqueue) */
114 		__P((struct ifnet *, struct mbuf *, struct sockaddr *,
115 		     struct rtentry *));
116 	void	(*if_start)		/* initiate output routine */
117 		__P((struct ifnet *));
118 	int	(*if_done)		/* output complete routine */
119 		__P((struct ifnet *));	/* (XXX not used; fake prototype) */
120 	int	(*if_ioctl)		/* ioctl routine */
121 		__P((struct ifnet *, int, caddr_t));
122 	void	(*if_watchdog)		/* timer routine */
123 		__P((struct ifnet *));
124 	int	(*if_poll_recv)		/* polled receive routine */
125 		__P((struct ifnet *, int *));
126 	int	(*if_poll_xmit)		/* polled transmit routine */
127 		__P((struct ifnet *, int *));
128 	void	(*if_poll_intren)	/* polled interrupt reenable routine */
129 		__P((struct ifnet *));
130 	void	(*if_poll_slowinput)	/* input routine for slow devices */
131 		__P((struct ifnet *, struct mbuf *));
132 	void	(*if_init)		/* Init routine */
133 		__P((void *));
134 	struct	ifqueue if_snd;		/* output queue */
135 	struct	ifqueue *if_poll_slowq;	/* input queue for slow devices */
136 };
137 typedef void if_init_f_t __P((void *));
138 
139 #define	if_mtu		if_data.ifi_mtu
140 #define	if_type		if_data.ifi_type
141 #define if_physical	if_data.ifi_physical
142 #define	if_addrlen	if_data.ifi_addrlen
143 #define	if_hdrlen	if_data.ifi_hdrlen
144 #define	if_metric	if_data.ifi_metric
145 #define	if_baudrate	if_data.ifi_baudrate
146 #define	if_ipackets	if_data.ifi_ipackets
147 #define	if_ierrors	if_data.ifi_ierrors
148 #define	if_opackets	if_data.ifi_opackets
149 #define	if_oerrors	if_data.ifi_oerrors
150 #define	if_collisions	if_data.ifi_collisions
151 #define	if_ibytes	if_data.ifi_ibytes
152 #define	if_obytes	if_data.ifi_obytes
153 #define	if_imcasts	if_data.ifi_imcasts
154 #define	if_omcasts	if_data.ifi_omcasts
155 #define	if_iqdrops	if_data.ifi_iqdrops
156 #define	if_noproto	if_data.ifi_noproto
157 #define	if_lastchange	if_data.ifi_lastchange
158 #define if_recvquota	if_data.ifi_recvquota
159 #define	if_xmitquota	if_data.ifi_xmitquota
160 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0)
161 
162 /*
163  * Bit values in if_ipending
164  */
165 #define	IFI_RECV	1	/* I want to receive */
166 #define	IFI_XMIT	2	/* I want to transmit */
167 
168 /*
169  * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
170  * are queues of messages stored on ifqueue structures
171  * (defined above).  Entries are added to and deleted from these structures
172  * by these macros, which should be called with ipl raised to splimp().
173  */
174 #define	IF_QFULL(ifq)		((ifq)->ifq_len >= (ifq)->ifq_maxlen)
175 #define	IF_DROP(ifq)		((ifq)->ifq_drops++)
176 #define	IF_ENQUEUE(ifq, m) { \
177 	(m)->m_nextpkt = 0; \
178 	if ((ifq)->ifq_tail == 0) \
179 		(ifq)->ifq_head = m; \
180 	else \
181 		(ifq)->ifq_tail->m_nextpkt = m; \
182 	(ifq)->ifq_tail = m; \
183 	(ifq)->ifq_len++; \
184 }
185 #define	IF_PREPEND(ifq, m) { \
186 	(m)->m_nextpkt = (ifq)->ifq_head; \
187 	if ((ifq)->ifq_tail == 0) \
188 		(ifq)->ifq_tail = (m); \
189 	(ifq)->ifq_head = (m); \
190 	(ifq)->ifq_len++; \
191 }
192 #define	IF_DEQUEUE(ifq, m) { \
193 	(m) = (ifq)->ifq_head; \
194 	if (m) { \
195 		if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
196 			(ifq)->ifq_tail = 0; \
197 		(m)->m_nextpkt = 0; \
198 		(ifq)->ifq_len--; \
199 	} \
200 }
201 
202 #ifdef KERNEL
203 #define	IF_ENQ_DROP(ifq, m)	if_enq_drop(ifq, m)
204 
205 #if defined(__GNUC__) && defined(MT_HEADER)
206 static inline int
207 if_queue_drop(struct ifqueue *ifq, struct mbuf *m)
208 {
209 	IF_DROP(ifq);
210 	return 0;
211 }
212 
213 static inline int
214 if_enq_drop(struct ifqueue *ifq, struct mbuf *m)
215 {
216 	if (IF_QFULL(ifq) &&
217 	    !if_queue_drop(ifq, m))
218 		return 0;
219 	IF_ENQUEUE(ifq, m);
220 	return 1;
221 }
222 #else
223 
224 #ifdef MT_HEADER
225 int	if_enq_drop __P((struct ifqueue *, struct mbuf *));
226 #endif
227 
228 #endif
229 #endif /* KERNEL */
230 
231 /*
232  * The ifaddr structure contains information about one address
233  * of an interface.  They are maintained by the different address families,
234  * are allocated and attached when an address is set, and are linked
235  * together so all addresses for an interface can be located.
236  */
237 struct ifaddr {
238 	struct	sockaddr *ifa_addr;	/* address of interface */
239 	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
240 #define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
241 	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
242 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
243 	TAILQ_ENTRY(ifaddr) ifa_link;	/* queue macro glue */
244 	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
245 		__P((int, struct rtentry *, struct sockaddr *));
246 	u_short	ifa_flags;		/* mostly rt_flags for cloning */
247 	short	ifa_refcnt;		/* references to this structure */
248 	int	ifa_metric;		/* cost of going out this interface */
249 #ifdef notdef
250 	struct	rtentry *ifa_rt;	/* XXXX for ROUTETOIF ????? */
251 #endif
252 };
253 #define	IFA_ROUTE	RTF_UP		/* route installed */
254 
255 #ifdef KERNEL
256 #define	IFAFREE(ifa) \
257 	if ((ifa)->ifa_refcnt <= 0) \
258 		ifafree(ifa); \
259 	else \
260 		(ifa)->ifa_refcnt--;
261 
262 extern	struct ifnethead ifnet;
263 extern	int ifqmaxlen;
264 extern	struct ifnet loif[];
265 extern	int if_index;
266 extern	struct ifaddr **ifnet_addrs;
267 
268 void	ether_ifattach __P((struct ifnet *));
269 void	ether_input __P((struct ifnet *, struct ether_header *, struct mbuf *));
270 int	ether_output __P((struct ifnet *,
271 	   struct mbuf *, struct sockaddr *, struct rtentry *));
272 int	ether_ioctl __P((struct ifnet *, int, caddr_t));
273 
274 void	if_attach __P((struct ifnet *));
275 void	if_down __P((struct ifnet *));
276 void	if_up __P((struct ifnet *));
277 #ifdef vax
278 void	ifubareset __P((int));
279 #endif
280 /*void	ifinit __P((void));*/ /* declared in systm.h for main() */
281 int	ifioctl __P((struct socket *, int, caddr_t, struct proc *));
282 int	ifpromisc __P((struct ifnet *, int));
283 struct	ifnet *ifunit __P((char *));
284 
285 int	if_poll_recv_slow __P((struct ifnet *ifp, int *quotap));
286 void	if_poll_xmit_slow __P((struct ifnet *ifp, int *quotap));
287 void	if_poll_throttle __P((void));
288 void	if_poll_unthrottle __P((void *));
289 void	if_poll_init __P((void));
290 void	if_poll __P((void));
291 
292 struct	ifaddr *ifa_ifwithaddr __P((struct sockaddr *));
293 struct	ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *));
294 struct	ifaddr *ifa_ifwithnet __P((struct sockaddr *));
295 struct	ifaddr *ifa_ifwithroute __P((int, struct sockaddr *,
296 					struct sockaddr *));
297 struct	ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *));
298 void	ifafree __P((struct ifaddr *));
299 
300 int	looutput __P((struct ifnet *,
301 	   struct mbuf *, struct sockaddr *, struct rtentry *));
302 #endif /* KERNEL */
303 
304 
305 #endif /* !_NET_IF_VAR_H_ */
306