if.h revision 1.60 1 1.60 thorpej /* $NetBSD: if.h,v 1.60 2000/12/18 20:58:41 thorpej Exp $ */
2 1.44 thorpej
3 1.44 thorpej /*-
4 1.44 thorpej * Copyright (c) 1999, 2000 The NetBSD Foundation, Inc.
5 1.44 thorpej * All rights reserved.
6 1.44 thorpej *
7 1.44 thorpej * This code is derived from software contributed to The NetBSD Foundation
8 1.44 thorpej * by William Studnemund and Jason R. Thorpe.
9 1.44 thorpej *
10 1.44 thorpej * Redistribution and use in source and binary forms, with or without
11 1.44 thorpej * modification, are permitted provided that the following conditions
12 1.44 thorpej * are met:
13 1.44 thorpej * 1. Redistributions of source code must retain the above copyright
14 1.44 thorpej * notice, this list of conditions and the following disclaimer.
15 1.44 thorpej * 2. Redistributions in binary form must reproduce the above copyright
16 1.44 thorpej * notice, this list of conditions and the following disclaimer in the
17 1.44 thorpej * documentation and/or other materials provided with the distribution.
18 1.44 thorpej * 3. All advertising materials mentioning features or use of this software
19 1.44 thorpej * must display the following acknowledgement:
20 1.44 thorpej * This product includes software developed by the NetBSD
21 1.44 thorpej * Foundation, Inc. and its contributors.
22 1.44 thorpej * 4. Neither the name of The NetBSD Foundation nor the names of its
23 1.44 thorpej * contributors may be used to endorse or promote products derived
24 1.44 thorpej * from this software without specific prior written permission.
25 1.44 thorpej *
26 1.44 thorpej * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 1.44 thorpej * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 1.44 thorpej * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 1.44 thorpej * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 1.44 thorpej * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 1.44 thorpej * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 1.44 thorpej * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 1.44 thorpej * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 1.44 thorpej * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 1.44 thorpej * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 1.44 thorpej * POSSIBILITY OF SUCH DAMAGE.
37 1.44 thorpej */
38 1.10 cgd
39 1.1 cgd /*
40 1.9 mycroft * Copyright (c) 1982, 1986, 1989, 1993
41 1.9 mycroft * The Regents of the University of California. All rights reserved.
42 1.1 cgd *
43 1.1 cgd * Redistribution and use in source and binary forms, with or without
44 1.1 cgd * modification, are permitted provided that the following conditions
45 1.1 cgd * are met:
46 1.1 cgd * 1. Redistributions of source code must retain the above copyright
47 1.1 cgd * notice, this list of conditions and the following disclaimer.
48 1.1 cgd * 2. Redistributions in binary form must reproduce the above copyright
49 1.1 cgd * notice, this list of conditions and the following disclaimer in the
50 1.1 cgd * documentation and/or other materials provided with the distribution.
51 1.1 cgd * 3. All advertising materials mentioning features or use of this software
52 1.1 cgd * must display the following acknowledgement:
53 1.1 cgd * This product includes software developed by the University of
54 1.1 cgd * California, Berkeley and its contributors.
55 1.1 cgd * 4. Neither the name of the University nor the names of its contributors
56 1.1 cgd * may be used to endorse or promote products derived from this software
57 1.1 cgd * without specific prior written permission.
58 1.1 cgd *
59 1.1 cgd * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60 1.1 cgd * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61 1.1 cgd * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62 1.1 cgd * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63 1.1 cgd * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64 1.1 cgd * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65 1.1 cgd * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66 1.1 cgd * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67 1.1 cgd * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68 1.1 cgd * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69 1.1 cgd * SUCH DAMAGE.
70 1.1 cgd *
71 1.30 fvdl * @(#)if.h 8.3 (Berkeley) 2/9/95
72 1.1 cgd */
73 1.1 cgd
74 1.28 chuck #ifndef _NET_IF_H_
75 1.28 chuck #define _NET_IF_H_
76 1.28 chuck
77 1.38 kleink #if !defined(_XOPEN_SOURCE)
78 1.38 kleink
79 1.17 mycroft #include <sys/queue.h>
80 1.60 thorpej #include <net/dlt.h>
81 1.17 mycroft
82 1.1 cgd /*
83 1.58 thorpej * Always include ALTQ glue here -- we use the ALTQ interface queue
84 1.58 thorpej * structure even when ALTQ is not configured into the kernel so that
85 1.58 thorpej * the size of struct ifnet does not changed based on the option. The
86 1.58 thorpej * ALTQ queue structure is API-compatible with the legacy ifqueue.
87 1.58 thorpej */
88 1.58 thorpej #include <altq/if_altq.h>
89 1.58 thorpej
90 1.58 thorpej /*
91 1.1 cgd * Structures defining a network interface, providing a packet
92 1.1 cgd * transport mechanism (ala level 0 of the PUP protocols).
93 1.1 cgd *
94 1.1 cgd * Each interface accepts output datagrams of a specified maximum
95 1.1 cgd * length, and provides higher level routines with input datagrams
96 1.1 cgd * received from its medium.
97 1.1 cgd *
98 1.9 mycroft * Output occurs when the routine if_output is called, with four parameters:
99 1.9 mycroft * (*ifp->if_output)(ifp, m, dst, rt)
100 1.1 cgd * Here m is the mbuf chain to be sent and dst is the destination address.
101 1.1 cgd * The output routine encapsulates the supplied datagram if necessary,
102 1.1 cgd * and then transmits it on its medium.
103 1.1 cgd *
104 1.1 cgd * On input, each interface unwraps the data received by it, and either
105 1.1 cgd * places it on the input queue of a internetwork datagram routine
106 1.1 cgd * and posts the associated software interrupt, or passes the datagram to a raw
107 1.1 cgd * packet input routine.
108 1.1 cgd *
109 1.1 cgd * Routines exist for locating interfaces by their addresses
110 1.1 cgd * or for locating a interface on a certain network, as well as more general
111 1.1 cgd * routing and gateway routines maintaining information used to locate
112 1.1 cgd * interfaces. These routines live in the files if.c and route.c
113 1.1 cgd */
114 1.7 mycroft /* XXX fast fix for SNMP, going away soon */
115 1.1 cgd #include <sys/time.h>
116 1.1 cgd
117 1.42 bouyer #if defined(_KERNEL) && !defined(_LKM)
118 1.42 bouyer #include "opt_compat_netbsd.h"
119 1.42 bouyer #endif
120 1.42 bouyer
121 1.9 mycroft struct mbuf;
122 1.9 mycroft struct proc;
123 1.9 mycroft struct rtentry;
124 1.9 mycroft struct socket;
125 1.9 mycroft struct ether_header;
126 1.51 thorpej struct ifnet;
127 1.51 thorpej
128 1.51 thorpej /*
129 1.53 thorpej * Length of interface external name, including terminating '\0'.
130 1.53 thorpej * Note: this is the same size as a generic device's external name.
131 1.53 thorpej */
132 1.53 thorpej #define IFNAMSIZ 16
133 1.53 thorpej #define IF_NAMESIZE IFNAMSIZ
134 1.53 thorpej
135 1.53 thorpej /*
136 1.51 thorpej * Structure describing a `cloning' interface.
137 1.51 thorpej */
138 1.51 thorpej struct if_clone {
139 1.51 thorpej LIST_ENTRY(if_clone) ifc_list; /* on list of cloners */
140 1.51 thorpej const char *ifc_name; /* name of device, e.g. `gif' */
141 1.51 thorpej size_t ifc_namelen; /* length of name */
142 1.51 thorpej
143 1.51 thorpej int (*ifc_create)(struct if_clone *, int);
144 1.51 thorpej void (*ifc_destroy)(struct ifnet *);
145 1.51 thorpej };
146 1.51 thorpej
147 1.51 thorpej #define IF_CLONE_INITIALIZER(name, create, destroy) \
148 1.51 thorpej { { 0 }, name, sizeof(name) - 1, create, destroy }
149 1.9 mycroft
150 1.1 cgd /*
151 1.53 thorpej * Structure used to query names of interface cloners.
152 1.53 thorpej */
153 1.53 thorpej struct if_clonereq {
154 1.53 thorpej int ifcr_total; /* total cloners (out) */
155 1.53 thorpej int ifcr_count; /* room for this many in user buffer */
156 1.53 thorpej char *ifcr_buffer; /* buffer for cloner names */
157 1.53 thorpej };
158 1.53 thorpej
159 1.53 thorpej /*
160 1.12 cgd * Structure defining statistics and other data kept regarding a network
161 1.12 cgd * interface.
162 1.12 cgd */
163 1.46 thorpej struct if_data {
164 1.12 cgd /* generic interface information */
165 1.12 cgd u_char ifi_type; /* ethernet, tokenring, etc. */
166 1.12 cgd u_char ifi_addrlen; /* media address length */
167 1.12 cgd u_char ifi_hdrlen; /* media header length */
168 1.46 thorpej int ifi_link_state; /* current link state */
169 1.42 bouyer u_quad_t ifi_mtu; /* maximum transmission unit */
170 1.42 bouyer u_quad_t ifi_metric; /* routing metric (external only) */
171 1.42 bouyer u_quad_t ifi_baudrate; /* linespeed */
172 1.42 bouyer /* volatile statistics */
173 1.42 bouyer u_quad_t ifi_ipackets; /* packets received on interface */
174 1.42 bouyer u_quad_t ifi_ierrors; /* input errors on interface */
175 1.42 bouyer u_quad_t ifi_opackets; /* packets sent on interface */
176 1.42 bouyer u_quad_t ifi_oerrors; /* output errors on interface */
177 1.42 bouyer u_quad_t ifi_collisions; /* collisions on csma interfaces */
178 1.42 bouyer u_quad_t ifi_ibytes; /* total number of octets received */
179 1.42 bouyer u_quad_t ifi_obytes; /* total number of octets sent */
180 1.42 bouyer u_quad_t ifi_imcasts; /* packets received via multicast */
181 1.42 bouyer u_quad_t ifi_omcasts; /* packets sent via multicast */
182 1.42 bouyer u_quad_t ifi_iqdrops; /* dropped on input, this interface */
183 1.42 bouyer u_quad_t ifi_noproto; /* destined for unsupported protocol */
184 1.42 bouyer struct timeval ifi_lastchange; /* last updated */
185 1.42 bouyer };
186 1.42 bouyer
187 1.46 thorpej /*
188 1.46 thorpej * Values for if_link_state.
189 1.46 thorpej */
190 1.46 thorpej #define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */
191 1.46 thorpej #define LINK_STATE_DOWN 1 /* link is down */
192 1.46 thorpej #define LINK_STATE_UP 2 /* link is up */
193 1.46 thorpej
194 1.45 kleink #if defined(_KERNEL) && defined(COMPAT_14)
195 1.42 bouyer /* Pre-1.5 if_data struct */
196 1.46 thorpej struct if_data14 {
197 1.42 bouyer /* generic interface information */
198 1.42 bouyer u_char ifi_type; /* ethernet, tokenring, etc. */
199 1.42 bouyer u_char ifi_addrlen; /* media address length */
200 1.42 bouyer u_char ifi_hdrlen; /* media header length */
201 1.12 cgd u_long ifi_mtu; /* maximum transmission unit */
202 1.12 cgd u_long ifi_metric; /* routing metric (external only) */
203 1.12 cgd u_long ifi_baudrate; /* linespeed */
204 1.12 cgd /* volatile statistics */
205 1.12 cgd u_long ifi_ipackets; /* packets received on interface */
206 1.12 cgd u_long ifi_ierrors; /* input errors on interface */
207 1.12 cgd u_long ifi_opackets; /* packets sent on interface */
208 1.12 cgd u_long ifi_oerrors; /* output errors on interface */
209 1.12 cgd u_long ifi_collisions; /* collisions on csma interfaces */
210 1.12 cgd u_long ifi_ibytes; /* total number of octets received */
211 1.12 cgd u_long ifi_obytes; /* total number of octets sent */
212 1.12 cgd u_long ifi_imcasts; /* packets received via multicast */
213 1.12 cgd u_long ifi_omcasts; /* packets sent via multicast */
214 1.12 cgd u_long ifi_iqdrops; /* dropped on input, this interface */
215 1.12 cgd u_long ifi_noproto; /* destined for unsupported protocol */
216 1.12 cgd struct timeval ifi_lastchange; /* last updated */
217 1.12 cgd };
218 1.45 kleink #endif /* _KERNEL && COMPAT_14 */
219 1.12 cgd
220 1.12 cgd /*
221 1.1 cgd * Structure defining a queue for a network interface.
222 1.55 thorpej */
223 1.55 thorpej struct ifqueue {
224 1.55 thorpej struct mbuf *ifq_head;
225 1.55 thorpej struct mbuf *ifq_tail;
226 1.55 thorpej int ifq_len;
227 1.55 thorpej int ifq_maxlen;
228 1.55 thorpej int ifq_drops;
229 1.55 thorpej };
230 1.55 thorpej
231 1.55 thorpej /*
232 1.55 thorpej * Structure defining a queue for a network interface.
233 1.1 cgd *
234 1.1 cgd * (Would like to call this struct ``if'', but C isn't PL/1.)
235 1.1 cgd */
236 1.19 cgd TAILQ_HEAD(ifnet_head, ifnet); /* the actual queue head */
237 1.23 thorpej
238 1.19 cgd struct ifnet { /* and the entries */
239 1.23 thorpej void *if_softc; /* lower-level data for this if */
240 1.17 mycroft TAILQ_ENTRY(ifnet) if_list; /* all struct ifnets are chained */
241 1.17 mycroft TAILQ_HEAD(, ifaddr) if_addrlist; /* linked list of addresses per if */
242 1.23 thorpej char if_xname[IFNAMSIZ]; /* external name (name + unit) */
243 1.9 mycroft int if_pcount; /* number of promiscuous listeners */
244 1.9 mycroft caddr_t if_bpf; /* packet filter structure */
245 1.9 mycroft u_short if_index; /* numeric abbreviation for this if */
246 1.9 mycroft short if_timer; /* time 'til if_watchdog called */
247 1.1 cgd short if_flags; /* up/down, broadcast, etc. */
248 1.25 gwr short if__pad1; /* be nice to m68k ports */
249 1.12 cgd struct if_data if_data; /* statistics and other data about if */
250 1.44 thorpej /*
251 1.44 thorpej * Procedure handles. If you add more of these, don't forget the
252 1.44 thorpej * corresponding NULL stub in if.c.
253 1.44 thorpej */
254 1.9 mycroft int (*if_output) /* output routine (enqueue) */
255 1.9 mycroft __P((struct ifnet *, struct mbuf *, struct sockaddr *,
256 1.9 mycroft struct rtentry *));
257 1.36 thorpej void (*if_input) /* input routine (from h/w driver) */
258 1.36 thorpej __P((struct ifnet *, struct mbuf *));
259 1.16 mycroft void (*if_start) /* initiate output routine */
260 1.9 mycroft __P((struct ifnet *));
261 1.9 mycroft int (*if_ioctl) /* ioctl routine */
262 1.13 cgd __P((struct ifnet *, u_long, caddr_t));
263 1.54 thorpej int (*if_init) /* init routine */
264 1.23 thorpej __P((struct ifnet *));
265 1.54 thorpej void (*if_stop) /* stop routine */
266 1.54 thorpej __P((struct ifnet *, int));
267 1.16 mycroft void (*if_watchdog) /* timer routine */
268 1.32 matt __P((struct ifnet *));
269 1.32 matt void (*if_drain) /* routine to release resources */
270 1.23 thorpej __P((struct ifnet *));
271 1.55 thorpej struct ifaltq if_snd; /* output queue (includes altq) */
272 1.26 is struct sockaddr_dl *if_sadl; /* pointer to our sockaddr_dl */
273 1.29 is u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
274 1.37 itojun struct ifprefix *if_prefixlist; /* linked list of prefixes per if */
275 1.55 thorpej void *if_bridge; /* bridge glue */
276 1.59 thorpej int if_dlt; /* data link type (<net/dlt.h>) */
277 1.1 cgd };
278 1.9 mycroft #define if_mtu if_data.ifi_mtu
279 1.9 mycroft #define if_type if_data.ifi_type
280 1.9 mycroft #define if_addrlen if_data.ifi_addrlen
281 1.9 mycroft #define if_hdrlen if_data.ifi_hdrlen
282 1.9 mycroft #define if_metric if_data.ifi_metric
283 1.46 thorpej #define if_link_state if_data.ifi_link_state
284 1.9 mycroft #define if_baudrate if_data.ifi_baudrate
285 1.9 mycroft #define if_ipackets if_data.ifi_ipackets
286 1.9 mycroft #define if_ierrors if_data.ifi_ierrors
287 1.9 mycroft #define if_opackets if_data.ifi_opackets
288 1.9 mycroft #define if_oerrors if_data.ifi_oerrors
289 1.9 mycroft #define if_collisions if_data.ifi_collisions
290 1.9 mycroft #define if_ibytes if_data.ifi_ibytes
291 1.9 mycroft #define if_obytes if_data.ifi_obytes
292 1.9 mycroft #define if_imcasts if_data.ifi_imcasts
293 1.9 mycroft #define if_omcasts if_data.ifi_omcasts
294 1.9 mycroft #define if_iqdrops if_data.ifi_iqdrops
295 1.9 mycroft #define if_noproto if_data.ifi_noproto
296 1.9 mycroft #define if_lastchange if_data.ifi_lastchange
297 1.1 cgd
298 1.1 cgd #define IFF_UP 0x1 /* interface is up */
299 1.1 cgd #define IFF_BROADCAST 0x2 /* broadcast address valid */
300 1.1 cgd #define IFF_DEBUG 0x4 /* turn on debugging */
301 1.1 cgd #define IFF_LOOPBACK 0x8 /* is a loopback net */
302 1.1 cgd #define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */
303 1.1 cgd #define IFF_NOTRAILERS 0x20 /* avoid use of trailers */
304 1.1 cgd #define IFF_RUNNING 0x40 /* resources allocated */
305 1.1 cgd #define IFF_NOARP 0x80 /* no address resolution protocol */
306 1.1 cgd #define IFF_PROMISC 0x100 /* receive all packets */
307 1.1 cgd #define IFF_ALLMULTI 0x200 /* receive all multicast packets */
308 1.1 cgd #define IFF_OACTIVE 0x400 /* transmission in progress */
309 1.1 cgd #define IFF_SIMPLEX 0x800 /* can't hear own transmissions */
310 1.5 cgd #define IFF_LINK0 0x1000 /* per link layer defined bit */
311 1.6 cgd #define IFF_LINK1 0x2000 /* per link layer defined bit */
312 1.6 cgd #define IFF_LINK2 0x4000 /* per link layer defined bit */
313 1.9 mycroft #define IFF_MULTICAST 0x8000 /* supports multicast */
314 1.4 hpeyerl
315 1.1 cgd /* flags set internally only: */
316 1.9 mycroft #define IFF_CANTCHANGE \
317 1.9 mycroft (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
318 1.52 thorpej IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_PROMISC)
319 1.1 cgd
320 1.1 cgd /*
321 1.46 thorpej * Some convenience macros used for setting ifi_baudrate.
322 1.46 thorpej * XXX 1000 vs. 1024? --thorpej (at) netbsd.org
323 1.46 thorpej */
324 1.46 thorpej #define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */
325 1.46 thorpej #define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */
326 1.46 thorpej #define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */
327 1.46 thorpej
328 1.46 thorpej /*
329 1.1 cgd * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
330 1.1 cgd * input routines have queues of messages stored on ifqueue structures
331 1.1 cgd * (defined above). Entries are added to and deleted from these structures
332 1.1 cgd * by these macros, which should be called with ipl raised to splimp().
333 1.1 cgd */
334 1.1 cgd #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
335 1.1 cgd #define IF_DROP(ifq) ((ifq)->ifq_drops++)
336 1.1 cgd #define IF_ENQUEUE(ifq, m) { \
337 1.1 cgd (m)->m_nextpkt = 0; \
338 1.1 cgd if ((ifq)->ifq_tail == 0) \
339 1.1 cgd (ifq)->ifq_head = m; \
340 1.1 cgd else \
341 1.1 cgd (ifq)->ifq_tail->m_nextpkt = m; \
342 1.1 cgd (ifq)->ifq_tail = m; \
343 1.1 cgd (ifq)->ifq_len++; \
344 1.1 cgd }
345 1.1 cgd #define IF_PREPEND(ifq, m) { \
346 1.1 cgd (m)->m_nextpkt = (ifq)->ifq_head; \
347 1.1 cgd if ((ifq)->ifq_tail == 0) \
348 1.1 cgd (ifq)->ifq_tail = (m); \
349 1.1 cgd (ifq)->ifq_head = (m); \
350 1.1 cgd (ifq)->ifq_len++; \
351 1.1 cgd }
352 1.1 cgd #define IF_DEQUEUE(ifq, m) { \
353 1.1 cgd (m) = (ifq)->ifq_head; \
354 1.1 cgd if (m) { \
355 1.1 cgd if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
356 1.1 cgd (ifq)->ifq_tail = 0; \
357 1.1 cgd (m)->m_nextpkt = 0; \
358 1.1 cgd (ifq)->ifq_len--; \
359 1.1 cgd } \
360 1.1 cgd }
361 1.55 thorpej #define IF_POLL(ifq, m) ((m) = (ifq)->ifq_head)
362 1.55 thorpej #define IF_PURGE(ifq) \
363 1.55 thorpej do { \
364 1.55 thorpej struct mbuf *__m0; \
365 1.57 thorpej \
366 1.57 thorpej for (;;) { \
367 1.57 thorpej IF_DEQUEUE((ifq), __m0); \
368 1.57 thorpej if (__m0 == NULL) \
369 1.57 thorpej break; \
370 1.57 thorpej else \
371 1.57 thorpej m_freem(__m0); \
372 1.57 thorpej } \
373 1.55 thorpej } while (0)
374 1.55 thorpej #define IF_IS_EMPTY(ifq) ((ifq)->ifq_len == 0)
375 1.1 cgd
376 1.1 cgd #define IFQ_MAXLEN 50
377 1.1 cgd #define IFNET_SLOWHZ 1 /* granularity is 1 second */
378 1.1 cgd
379 1.1 cgd /*
380 1.35 aidan * Structure defining statistics and other data kept regarding an address
381 1.35 aidan * on a network interface.
382 1.35 aidan */
383 1.35 aidan struct ifaddr_data {
384 1.35 aidan int64_t ifad_inbytes;
385 1.35 aidan int64_t ifad_outbytes;
386 1.35 aidan };
387 1.35 aidan
388 1.35 aidan /*
389 1.1 cgd * The ifaddr structure contains information about one address
390 1.1 cgd * of an interface. They are maintained by the different address families,
391 1.1 cgd * are allocated and attached when an address is set, and are linked
392 1.1 cgd * together so all addresses for an interface can be located.
393 1.1 cgd */
394 1.1 cgd struct ifaddr {
395 1.1 cgd struct sockaddr *ifa_addr; /* address of interface */
396 1.1 cgd struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
397 1.1 cgd #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
398 1.1 cgd struct sockaddr *ifa_netmask; /* used to determine subnet */
399 1.1 cgd struct ifnet *ifa_ifp; /* back-pointer to interface */
400 1.17 mycroft TAILQ_ENTRY(ifaddr) ifa_list; /* list of addresses for interface */
401 1.35 aidan struct ifaddr_data ifa_data; /* statistics on the address */
402 1.20 christos void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
403 1.20 christos __P((int, struct rtentry *, struct sockaddr *));
404 1.41 wrstuden u_int ifa_flags; /* mostly rt_flags for cloning */
405 1.41 wrstuden int ifa_refcnt; /* count of references */
406 1.9 mycroft int ifa_metric; /* cost of going out this interface */
407 1.1 cgd };
408 1.9 mycroft #define IFA_ROUTE RTF_UP /* route installed */
409 1.9 mycroft
410 1.9 mycroft /*
411 1.37 itojun * The prefix structure contains information about one prefix
412 1.37 itojun * of an interface. They are maintained by the different address families,
413 1.43 itojun * are allocated and attached when an prefix or an address is set,
414 1.37 itojun * and are linked together so all prfefixes for an interface can be located.
415 1.37 itojun */
416 1.37 itojun struct ifprefix {
417 1.37 itojun struct sockaddr *ifpr_prefix; /* prefix of interface */
418 1.37 itojun struct ifnet *ifpr_ifp; /* back-pointer to interface */
419 1.37 itojun struct ifprefix *ifpr_next;
420 1.37 itojun u_char ifpr_plen; /* prefix length in bits */
421 1.43 itojun u_char ifpr_type; /* protocol dependent prefix type */
422 1.37 itojun };
423 1.37 itojun
424 1.37 itojun /*
425 1.9 mycroft * Message format for use in obtaining information about interfaces
426 1.9 mycroft * from sysctl and the routing socket.
427 1.9 mycroft */
428 1.9 mycroft struct if_msghdr {
429 1.9 mycroft u_short ifm_msglen; /* to skip over non-understood messages */
430 1.9 mycroft u_char ifm_version; /* future binary compatability */
431 1.9 mycroft u_char ifm_type; /* message type */
432 1.9 mycroft int ifm_addrs; /* like rtm_addrs */
433 1.9 mycroft int ifm_flags; /* value of if_flags */
434 1.9 mycroft u_short ifm_index; /* index for associated ifp */
435 1.9 mycroft struct if_data ifm_data;/* statistics and other data about if */
436 1.9 mycroft };
437 1.42 bouyer
438 1.45 kleink #if defined(_KERNEL) && defined(COMPAT_14)
439 1.42 bouyer /* pre-1.5 if_msghdr (ifm_data changed) */
440 1.42 bouyer struct if_msghdr14 {
441 1.42 bouyer u_short ifm_msglen; /* to skip over non-understood messages */
442 1.42 bouyer u_char ifm_version; /* future binary compatability */
443 1.42 bouyer u_char ifm_type; /* message type */
444 1.42 bouyer int ifm_addrs; /* like rtm_addrs */
445 1.42 bouyer int ifm_flags; /* value of if_flags */
446 1.42 bouyer u_short ifm_index; /* index for associated ifp */
447 1.42 bouyer struct if_data14 ifm_data; /* statistics and other data about if */
448 1.42 bouyer };
449 1.45 kleink #endif /* _KERNEL && COMPAT_14 */
450 1.9 mycroft
451 1.9 mycroft /*
452 1.9 mycroft * Message format for use in obtaining information about interface addresses
453 1.9 mycroft * from sysctl and the routing socket.
454 1.9 mycroft */
455 1.9 mycroft struct ifa_msghdr {
456 1.9 mycroft u_short ifam_msglen; /* to skip over non-understood messages */
457 1.9 mycroft u_char ifam_version; /* future binary compatability */
458 1.9 mycroft u_char ifam_type; /* message type */
459 1.9 mycroft int ifam_addrs; /* like rtm_addrs */
460 1.9 mycroft int ifam_flags; /* value of ifa_flags */
461 1.9 mycroft u_short ifam_index; /* index for associated ifp */
462 1.9 mycroft int ifam_metric; /* value of ifa_metric */
463 1.9 mycroft };
464 1.46 thorpej
465 1.46 thorpej /*
466 1.46 thorpej * Message format announcing the arrival or departure of a network interface.
467 1.46 thorpej */
468 1.46 thorpej struct if_announcemsghdr {
469 1.46 thorpej u_short ifan_msglen; /* to skip over non-understood messages */
470 1.46 thorpej u_char ifan_version; /* future binary compatibility */
471 1.46 thorpej u_char ifan_type; /* message type */
472 1.46 thorpej u_short ifan_index; /* index for associated ifp */
473 1.46 thorpej char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
474 1.46 thorpej u_short ifan_what; /* what type of announcement */
475 1.46 thorpej };
476 1.46 thorpej
477 1.46 thorpej #define IFAN_ARRIVAL 0 /* interface arrival */
478 1.46 thorpej #define IFAN_DEPARTURE 1 /* interface departure */
479 1.9 mycroft
480 1.1 cgd /*
481 1.1 cgd * Interface request structure used for socket
482 1.1 cgd * ioctl's. All interface ioctl's must have parameter
483 1.1 cgd * definitions which begin with ifr_name. The
484 1.1 cgd * remainder may be interface specific.
485 1.1 cgd */
486 1.1 cgd struct ifreq {
487 1.1 cgd char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */
488 1.1 cgd union {
489 1.1 cgd struct sockaddr ifru_addr;
490 1.1 cgd struct sockaddr ifru_dstaddr;
491 1.1 cgd struct sockaddr ifru_broadaddr;
492 1.1 cgd short ifru_flags;
493 1.1 cgd int ifru_metric;
494 1.24 cgd int ifru_mtu;
495 1.39 matt u_int ifru_value;
496 1.1 cgd caddr_t ifru_data;
497 1.1 cgd } ifr_ifru;
498 1.1 cgd #define ifr_addr ifr_ifru.ifru_addr /* address */
499 1.1 cgd #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */
500 1.1 cgd #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
501 1.1 cgd #define ifr_flags ifr_ifru.ifru_flags /* flags */
502 1.1 cgd #define ifr_metric ifr_ifru.ifru_metric /* metric */
503 1.24 cgd #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
504 1.39 matt #define ifr_value ifr_ifru.ifru_value /* generic value */
505 1.27 thorpej #define ifr_media ifr_ifru.ifru_metric /* media options (overload) */
506 1.1 cgd #define ifr_data ifr_ifru.ifru_data /* for use by interface */
507 1.50 itojun };
508 1.1 cgd
509 1.1 cgd struct ifaliasreq {
510 1.1 cgd char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
511 1.1 cgd struct sockaddr ifra_addr;
512 1.21 pk struct sockaddr ifra_dstaddr;
513 1.21 pk #define ifra_broadaddr ifra_dstaddr
514 1.1 cgd struct sockaddr ifra_mask;
515 1.27 thorpej };
516 1.27 thorpej
517 1.27 thorpej struct ifmediareq {
518 1.27 thorpej char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */
519 1.27 thorpej int ifm_current; /* current media options */
520 1.27 thorpej int ifm_mask; /* don't care mask */
521 1.27 thorpej int ifm_status; /* media status */
522 1.27 thorpej int ifm_active; /* active options */
523 1.27 thorpej int ifm_count; /* # entries in ifm_ulist
524 1.27 thorpej array */
525 1.27 thorpej int *ifm_ulist; /* media words */
526 1.1 cgd };
527 1.31 kml
528 1.31 kml
529 1.31 kml struct ifdrv {
530 1.31 kml char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */
531 1.31 kml unsigned long ifd_cmd;
532 1.31 kml size_t ifd_len;
533 1.31 kml void *ifd_data;
534 1.31 kml };
535 1.1 cgd
536 1.1 cgd /*
537 1.1 cgd * Structure used in SIOCGIFCONF request.
538 1.1 cgd * Used to retrieve interface configuration
539 1.1 cgd * for machine (useful for programs which
540 1.1 cgd * must know all networks accessible).
541 1.1 cgd */
542 1.1 cgd struct ifconf {
543 1.1 cgd int ifc_len; /* size of associated buffer */
544 1.1 cgd union {
545 1.1 cgd caddr_t ifcu_buf;
546 1.1 cgd struct ifreq *ifcu_req;
547 1.1 cgd } ifc_ifcu;
548 1.1 cgd #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
549 1.1 cgd #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */
550 1.1 cgd };
551 1.1 cgd
552 1.37 itojun /*
553 1.37 itojun * Structure for SIOC[AGD]LIFADDR
554 1.37 itojun */
555 1.37 itojun struct if_laddrreq {
556 1.37 itojun char iflr_name[IFNAMSIZ];
557 1.37 itojun unsigned int flags;
558 1.37 itojun #define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */
559 1.37 itojun unsigned int prefixlen; /* in/out */
560 1.37 itojun struct sockaddr_storage addr; /* in/out */
561 1.37 itojun struct sockaddr_storage dstaddr; /* out */
562 1.37 itojun };
563 1.37 itojun
564 1.9 mycroft #include <net/if_arp.h>
565 1.9 mycroft
566 1.38 kleink #endif /* !_XOPEN_SOURCE */
567 1.38 kleink
568 1.15 jtc #ifdef _KERNEL
569 1.44 thorpej #ifdef IFAREF_DEBUG
570 1.44 thorpej #define IFAREF(ifa) \
571 1.44 thorpej do { \
572 1.44 thorpej printf("IFAREF: %s:%d %p -> %d\n", __FILE__, __LINE__, \
573 1.44 thorpej (ifa), ++(ifa)->ifa_refcnt); \
574 1.44 thorpej } while (0)
575 1.44 thorpej
576 1.44 thorpej #define IFAFREE(ifa) \
577 1.44 thorpej do { \
578 1.44 thorpej if ((ifa)->ifa_refcnt <= 0) \
579 1.44 thorpej panic("%s:%d: %p ifa_refcnt <= 0", __FILE__, \
580 1.44 thorpej __LINE__, (ifa)); \
581 1.44 thorpej printf("IFAFREE: %s:%d %p -> %d\n", __FILE__, __LINE__, \
582 1.44 thorpej (ifa), --(ifa)->ifa_refcnt); \
583 1.44 thorpej if ((ifa)->ifa_refcnt == 0) \
584 1.44 thorpej ifafree(ifa); \
585 1.44 thorpej } while (0)
586 1.44 thorpej #else
587 1.44 thorpej #define IFAREF(ifa) (ifa)->ifa_refcnt++
588 1.44 thorpej
589 1.44 thorpej #ifdef DIAGNOSTIC
590 1.44 thorpej #define IFAFREE(ifa) \
591 1.44 thorpej do { \
592 1.44 thorpej if ((ifa)->ifa_refcnt <= 0) \
593 1.44 thorpej panic("%s:%d: %p ifa_refcnt <= 0", __FILE__, \
594 1.44 thorpej __LINE__, (ifa)); \
595 1.44 thorpej if (--(ifa)->ifa_refcnt == 0) \
596 1.44 thorpej ifafree(ifa); \
597 1.44 thorpej } while (0)
598 1.44 thorpej #else
599 1.44 thorpej #define IFAFREE(ifa) \
600 1.44 thorpej do { \
601 1.44 thorpej if (--(ifa)->ifa_refcnt == 0) \
602 1.44 thorpej ifafree(ifa); \
603 1.44 thorpej } while (0)
604 1.44 thorpej #endif /* DIAGNOSTIC */
605 1.44 thorpej #endif /* IFAREF_DEBUG */
606 1.55 thorpej
607 1.55 thorpej #ifdef ALTQ
608 1.55 thorpej #define ALTQ_DECL(x) x
609 1.55 thorpej
610 1.55 thorpej #define IFQ_ENQUEUE(ifq, m, pattr, err) \
611 1.55 thorpej do { \
612 1.55 thorpej if (ALTQ_IS_ENABLED((ifq))) \
613 1.55 thorpej ALTQ_ENQUEUE((ifq), (m), (pattr), (err)); \
614 1.55 thorpej else { \
615 1.55 thorpej if (IF_QFULL((ifq))) { \
616 1.55 thorpej m_freem((m)); \
617 1.55 thorpej (err) = ENOBUFS; \
618 1.55 thorpej } else { \
619 1.55 thorpej IF_ENQUEUE((ifq), (m)); \
620 1.55 thorpej (err) = 0; \
621 1.55 thorpej } \
622 1.55 thorpej } \
623 1.55 thorpej if ((err)) \
624 1.55 thorpej (ifq)->ifq_drops++; \
625 1.55 thorpej } while (0)
626 1.55 thorpej
627 1.55 thorpej #define IFQ_DEQUEUE(ifq, m) \
628 1.55 thorpej do { \
629 1.55 thorpej if (TBR_IS_ENABLED((ifq))) \
630 1.55 thorpej (m) = tbr_dequeue((ifq), ALTDQ_REMOVE); \
631 1.55 thorpej else if (ALTQ_IS_ENABLED((ifq))) \
632 1.55 thorpej ALTQ_DEQUEUE((ifq), (m)); \
633 1.56 thorpej else \
634 1.56 thorpej IF_POLL((ifq), (m)); \
635 1.56 thorpej } while (0)
636 1.56 thorpej
637 1.56 thorpej #define IFQ_POLL(ifq, m) \
638 1.56 thorpej do { \
639 1.56 thorpej if (TBR_IS_ENABLED((ifq))) \
640 1.56 thorpej (m) = tbr_dequeue((ifq), ALTDQ_POLL); \
641 1.56 thorpej else if (ALTQ_IS_ENABLED((ifq))) \
642 1.56 thorpej ALTQ_POLL((ifq), (m)); \
643 1.55 thorpej else \
644 1.55 thorpej IF_POLL((ifq), (m)); \
645 1.55 thorpej } while (0)
646 1.55 thorpej
647 1.55 thorpej #define IFQ_PURGE(ifq) \
648 1.55 thorpej do { \
649 1.55 thorpej if (ALTQ_IS_ENABLED((ifq))) \
650 1.55 thorpej ALTQ_PURGE((ifq)); \
651 1.55 thorpej else \
652 1.55 thorpej IF_PURGE((ifq)); \
653 1.55 thorpej } while (0)
654 1.55 thorpej
655 1.55 thorpej #define IFQ_SET_READY(ifq) \
656 1.55 thorpej do { \
657 1.55 thorpej (ifq)->altq_flags |= ALTQF_READY; \
658 1.55 thorpej } while (0)
659 1.55 thorpej
660 1.55 thorpej #define IFQ_CLASSIFY(ifq, m, af, pa) \
661 1.55 thorpej do { \
662 1.55 thorpej if (ALTQ_IS_ENABLED((ifq))) { \
663 1.55 thorpej if (ALTQ_NEEDS_CLASSIFY((ifq))) \
664 1.55 thorpej (pa)->pattr_class = (*(ifq)->altq_classify) \
665 1.55 thorpej ((ifq)->altq_clfier, (m), (af)); \
666 1.55 thorpej (pa)->pattr_af = (af); \
667 1.55 thorpej (pa)->pattr_hdr = mtod((m), caddr_t); \
668 1.55 thorpej } \
669 1.55 thorpej } while (0)
670 1.55 thorpej #else /* ! ALTQ */
671 1.55 thorpej #define ALTQ_DECL(x) /* nothing */
672 1.55 thorpej
673 1.55 thorpej #define IFQ_ENQUEUE(ifq, m, pattr, err) \
674 1.55 thorpej do { \
675 1.55 thorpej if (IF_QFULL((ifq))) { \
676 1.55 thorpej m_freem((m)); \
677 1.55 thorpej (err) = ENOBUFS; \
678 1.55 thorpej } else { \
679 1.55 thorpej IF_ENQUEUE((ifq), (m)); \
680 1.55 thorpej (err) = 0; \
681 1.55 thorpej } \
682 1.55 thorpej if ((err)) \
683 1.55 thorpej (ifq)->ifq_drops++; \
684 1.55 thorpej } while (0)
685 1.55 thorpej
686 1.55 thorpej #define IFQ_DEQUEUE(ifq, m) IF_DEQUEUE((ifq), (m))
687 1.55 thorpej
688 1.55 thorpej #define IFQ_POLL(ifq, m) IF_POLL((ifq), (m))
689 1.55 thorpej
690 1.55 thorpej #define IFQ_PURGE(ifq) IF_PURGE((ifq))
691 1.55 thorpej
692 1.55 thorpej #define IFQ_SET_READY(ifq) /* nothing */
693 1.55 thorpej
694 1.55 thorpej #define IFQ_CLASSIFY(ifq, m, af, pa) /* nothing */
695 1.55 thorpej
696 1.55 thorpej #endif /* ALTQ */
697 1.55 thorpej
698 1.55 thorpej #define IFQ_IS_EMPTY(ifq) IF_IS_EMPTY((ifq))
699 1.55 thorpej #define IFQ_INC_LEN(ifq) ((ifq)->ifq_len++)
700 1.55 thorpej #define IFQ_DEC_LEN(ifq) (--(ifq)->ifq_len)
701 1.55 thorpej #define IFQ_INC_DROPS(ifq) ((ifq)->ifq_drops++)
702 1.55 thorpej #define IFQ_SET_MAXLEN(ifq, len) ((ifq)->ifq_maxlen = (len))
703 1.9 mycroft
704 1.19 cgd struct ifnet_head ifnet;
705 1.48 simonb extern struct ifnet **ifindex2ifnet;
706 1.37 itojun #if 0
707 1.37 itojun struct ifnet loif[];
708 1.37 itojun #endif
709 1.48 simonb extern int if_index;
710 1.2 mycroft
711 1.34 thorpej void ether_ifattach __P((struct ifnet *, const u_int8_t *));
712 1.44 thorpej void ether_ifdetach __P((struct ifnet *));
713 1.33 thorpej char *ether_sprintf __P((const u_char *));
714 1.9 mycroft
715 1.9 mycroft void if_attach __P((struct ifnet *));
716 1.44 thorpej void if_deactivate __P((struct ifnet *));
717 1.44 thorpej void if_detach __P((struct ifnet *));
718 1.9 mycroft void if_down __P((struct ifnet *));
719 1.9 mycroft void if_slowtimo __P((void *));
720 1.9 mycroft void if_up __P((struct ifnet *));
721 1.14 cgd int ifconf __P((u_long, caddr_t));
722 1.9 mycroft void ifinit __P((void));
723 1.13 cgd int ifioctl __P((struct socket *, u_long, caddr_t, struct proc *));
724 1.9 mycroft int ifpromisc __P((struct ifnet *, int));
725 1.40 thorpej struct ifnet *ifunit __P((const char *));
726 1.9 mycroft
727 1.9 mycroft struct ifaddr *ifa_ifwithaddr __P((struct sockaddr *));
728 1.9 mycroft struct ifaddr *ifa_ifwithaf __P((int));
729 1.9 mycroft struct ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *));
730 1.9 mycroft struct ifaddr *ifa_ifwithnet __P((struct sockaddr *));
731 1.22 mrg struct ifaddr *ifa_ifwithladdr __P((struct sockaddr *));
732 1.9 mycroft struct ifaddr *ifa_ifwithroute __P((int, struct sockaddr *,
733 1.9 mycroft struct sockaddr *));
734 1.9 mycroft struct ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *));
735 1.9 mycroft void ifafree __P((struct ifaddr *));
736 1.9 mycroft void link_rtrequest __P((int, struct rtentry *, struct sockaddr *));
737 1.51 thorpej
738 1.51 thorpej void if_clone_attach __P((struct if_clone *));
739 1.51 thorpej void if_clone_detach __P((struct if_clone *));
740 1.51 thorpej
741 1.51 thorpej int if_clone_create __P((const char *));
742 1.51 thorpej int if_clone_destroy __P((const char *));
743 1.9 mycroft
744 1.13 cgd int loioctl __P((struct ifnet *, u_long, caddr_t));
745 1.9 mycroft void loopattach __P((int));
746 1.9 mycroft int looutput __P((struct ifnet *,
747 1.9 mycroft struct mbuf *, struct sockaddr *, struct rtentry *));
748 1.9 mycroft void lortrequest __P((int, struct rtentry *, struct sockaddr *));
749 1.44 thorpej
750 1.44 thorpej /*
751 1.44 thorpej * These are exported because they're an easy way to tell if
752 1.44 thorpej * an interface is going away without having to burn a flag.
753 1.44 thorpej */
754 1.44 thorpej int if_nulloutput __P((struct ifnet *, struct mbuf *,
755 1.44 thorpej struct sockaddr *, struct rtentry *));
756 1.44 thorpej void if_nullinput __P((struct ifnet *, struct mbuf *));
757 1.44 thorpej void if_nullstart __P((struct ifnet *));
758 1.44 thorpej int if_nullioctl __P((struct ifnet *, u_long, caddr_t));
759 1.54 thorpej int if_nullinit __P((struct ifnet *));
760 1.54 thorpej void if_nullstop __P((struct ifnet *, int));
761 1.44 thorpej void if_nullwatchdog __P((struct ifnet *));
762 1.44 thorpej void if_nulldrain __P((struct ifnet *));
763 1.37 itojun #else
764 1.37 itojun struct if_nameindex {
765 1.37 itojun unsigned int if_index; /* 1, 2, ... */
766 1.37 itojun char *if_name; /* null terminated name: "le0", ... */
767 1.37 itojun };
768 1.37 itojun
769 1.38 kleink #include <sys/cdefs.h>
770 1.37 itojun __BEGIN_DECLS
771 1.37 itojun unsigned int if_nametoindex __P((const char *));
772 1.38 kleink char * if_indextoname __P((unsigned int, char *));
773 1.38 kleink struct if_nameindex * if_nameindex __P((void));
774 1.38 kleink void if_freenameindex __P((struct if_nameindex *));
775 1.37 itojun __END_DECLS
776 1.15 jtc #endif /* _KERNEL */
777 1.28 chuck #endif /* !_NET_IF_H_ */
778