if.h revision 1.53 1 1.53 thorpej /* $NetBSD: if.h,v 1.53 2000/07/20 18:40:27 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.17 mycroft
81 1.1 cgd /*
82 1.1 cgd * Structures defining a network interface, providing a packet
83 1.1 cgd * transport mechanism (ala level 0 of the PUP protocols).
84 1.1 cgd *
85 1.1 cgd * Each interface accepts output datagrams of a specified maximum
86 1.1 cgd * length, and provides higher level routines with input datagrams
87 1.1 cgd * received from its medium.
88 1.1 cgd *
89 1.9 mycroft * Output occurs when the routine if_output is called, with four parameters:
90 1.9 mycroft * (*ifp->if_output)(ifp, m, dst, rt)
91 1.1 cgd * Here m is the mbuf chain to be sent and dst is the destination address.
92 1.1 cgd * The output routine encapsulates the supplied datagram if necessary,
93 1.1 cgd * and then transmits it on its medium.
94 1.1 cgd *
95 1.1 cgd * On input, each interface unwraps the data received by it, and either
96 1.1 cgd * places it on the input queue of a internetwork datagram routine
97 1.1 cgd * and posts the associated software interrupt, or passes the datagram to a raw
98 1.1 cgd * packet input routine.
99 1.1 cgd *
100 1.1 cgd * Routines exist for locating interfaces by their addresses
101 1.1 cgd * or for locating a interface on a certain network, as well as more general
102 1.1 cgd * routing and gateway routines maintaining information used to locate
103 1.1 cgd * interfaces. These routines live in the files if.c and route.c
104 1.1 cgd */
105 1.7 mycroft /* XXX fast fix for SNMP, going away soon */
106 1.1 cgd #include <sys/time.h>
107 1.1 cgd
108 1.42 bouyer #if defined(_KERNEL) && !defined(_LKM)
109 1.42 bouyer #include "opt_compat_netbsd.h"
110 1.42 bouyer #endif
111 1.42 bouyer
112 1.9 mycroft struct mbuf;
113 1.9 mycroft struct proc;
114 1.9 mycroft struct rtentry;
115 1.9 mycroft struct socket;
116 1.9 mycroft struct ether_header;
117 1.51 thorpej struct ifnet;
118 1.51 thorpej
119 1.51 thorpej /*
120 1.53 thorpej * Length of interface external name, including terminating '\0'.
121 1.53 thorpej * Note: this is the same size as a generic device's external name.
122 1.53 thorpej */
123 1.53 thorpej #define IFNAMSIZ 16
124 1.53 thorpej #define IF_NAMESIZE IFNAMSIZ
125 1.53 thorpej
126 1.53 thorpej /*
127 1.51 thorpej * Structure describing a `cloning' interface.
128 1.51 thorpej */
129 1.51 thorpej struct if_clone {
130 1.51 thorpej LIST_ENTRY(if_clone) ifc_list; /* on list of cloners */
131 1.51 thorpej const char *ifc_name; /* name of device, e.g. `gif' */
132 1.51 thorpej size_t ifc_namelen; /* length of name */
133 1.51 thorpej
134 1.51 thorpej int (*ifc_create)(struct if_clone *, int);
135 1.51 thorpej void (*ifc_destroy)(struct ifnet *);
136 1.51 thorpej };
137 1.51 thorpej
138 1.51 thorpej #define IF_CLONE_INITIALIZER(name, create, destroy) \
139 1.51 thorpej { { 0 }, name, sizeof(name) - 1, create, destroy }
140 1.9 mycroft
141 1.1 cgd /*
142 1.53 thorpej * Structure used to query names of interface cloners.
143 1.53 thorpej */
144 1.53 thorpej struct if_clonereq {
145 1.53 thorpej int ifcr_total; /* total cloners (out) */
146 1.53 thorpej int ifcr_count; /* room for this many in user buffer */
147 1.53 thorpej char *ifcr_buffer; /* buffer for cloner names */
148 1.53 thorpej };
149 1.53 thorpej
150 1.53 thorpej /*
151 1.12 cgd * Structure defining statistics and other data kept regarding a network
152 1.12 cgd * interface.
153 1.12 cgd */
154 1.46 thorpej struct if_data {
155 1.12 cgd /* generic interface information */
156 1.12 cgd u_char ifi_type; /* ethernet, tokenring, etc. */
157 1.12 cgd u_char ifi_addrlen; /* media address length */
158 1.12 cgd u_char ifi_hdrlen; /* media header length */
159 1.46 thorpej int ifi_link_state; /* current link state */
160 1.42 bouyer u_quad_t ifi_mtu; /* maximum transmission unit */
161 1.42 bouyer u_quad_t ifi_metric; /* routing metric (external only) */
162 1.42 bouyer u_quad_t ifi_baudrate; /* linespeed */
163 1.42 bouyer /* volatile statistics */
164 1.42 bouyer u_quad_t ifi_ipackets; /* packets received on interface */
165 1.42 bouyer u_quad_t ifi_ierrors; /* input errors on interface */
166 1.42 bouyer u_quad_t ifi_opackets; /* packets sent on interface */
167 1.42 bouyer u_quad_t ifi_oerrors; /* output errors on interface */
168 1.42 bouyer u_quad_t ifi_collisions; /* collisions on csma interfaces */
169 1.42 bouyer u_quad_t ifi_ibytes; /* total number of octets received */
170 1.42 bouyer u_quad_t ifi_obytes; /* total number of octets sent */
171 1.42 bouyer u_quad_t ifi_imcasts; /* packets received via multicast */
172 1.42 bouyer u_quad_t ifi_omcasts; /* packets sent via multicast */
173 1.42 bouyer u_quad_t ifi_iqdrops; /* dropped on input, this interface */
174 1.42 bouyer u_quad_t ifi_noproto; /* destined for unsupported protocol */
175 1.42 bouyer struct timeval ifi_lastchange; /* last updated */
176 1.42 bouyer };
177 1.42 bouyer
178 1.46 thorpej /*
179 1.46 thorpej * Values for if_link_state.
180 1.46 thorpej */
181 1.46 thorpej #define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */
182 1.46 thorpej #define LINK_STATE_DOWN 1 /* link is down */
183 1.46 thorpej #define LINK_STATE_UP 2 /* link is up */
184 1.46 thorpej
185 1.45 kleink #if defined(_KERNEL) && defined(COMPAT_14)
186 1.42 bouyer /* Pre-1.5 if_data struct */
187 1.46 thorpej struct if_data14 {
188 1.42 bouyer /* generic interface information */
189 1.42 bouyer u_char ifi_type; /* ethernet, tokenring, etc. */
190 1.42 bouyer u_char ifi_addrlen; /* media address length */
191 1.42 bouyer u_char ifi_hdrlen; /* media header length */
192 1.12 cgd u_long ifi_mtu; /* maximum transmission unit */
193 1.12 cgd u_long ifi_metric; /* routing metric (external only) */
194 1.12 cgd u_long ifi_baudrate; /* linespeed */
195 1.12 cgd /* volatile statistics */
196 1.12 cgd u_long ifi_ipackets; /* packets received on interface */
197 1.12 cgd u_long ifi_ierrors; /* input errors on interface */
198 1.12 cgd u_long ifi_opackets; /* packets sent on interface */
199 1.12 cgd u_long ifi_oerrors; /* output errors on interface */
200 1.12 cgd u_long ifi_collisions; /* collisions on csma interfaces */
201 1.12 cgd u_long ifi_ibytes; /* total number of octets received */
202 1.12 cgd u_long ifi_obytes; /* total number of octets sent */
203 1.12 cgd u_long ifi_imcasts; /* packets received via multicast */
204 1.12 cgd u_long ifi_omcasts; /* packets sent via multicast */
205 1.12 cgd u_long ifi_iqdrops; /* dropped on input, this interface */
206 1.12 cgd u_long ifi_noproto; /* destined for unsupported protocol */
207 1.12 cgd struct timeval ifi_lastchange; /* last updated */
208 1.12 cgd };
209 1.45 kleink #endif /* _KERNEL && COMPAT_14 */
210 1.12 cgd
211 1.12 cgd /*
212 1.1 cgd * Structure defining a queue for a network interface.
213 1.1 cgd *
214 1.1 cgd * (Would like to call this struct ``if'', but C isn't PL/1.)
215 1.1 cgd */
216 1.19 cgd TAILQ_HEAD(ifnet_head, ifnet); /* the actual queue head */
217 1.23 thorpej
218 1.19 cgd struct ifnet { /* and the entries */
219 1.23 thorpej void *if_softc; /* lower-level data for this if */
220 1.17 mycroft TAILQ_ENTRY(ifnet) if_list; /* all struct ifnets are chained */
221 1.17 mycroft TAILQ_HEAD(, ifaddr) if_addrlist; /* linked list of addresses per if */
222 1.23 thorpej char if_xname[IFNAMSIZ]; /* external name (name + unit) */
223 1.9 mycroft int if_pcount; /* number of promiscuous listeners */
224 1.9 mycroft caddr_t if_bpf; /* packet filter structure */
225 1.9 mycroft u_short if_index; /* numeric abbreviation for this if */
226 1.9 mycroft short if_timer; /* time 'til if_watchdog called */
227 1.1 cgd short if_flags; /* up/down, broadcast, etc. */
228 1.25 gwr short if__pad1; /* be nice to m68k ports */
229 1.12 cgd struct if_data if_data; /* statistics and other data about if */
230 1.44 thorpej /*
231 1.44 thorpej * Procedure handles. If you add more of these, don't forget the
232 1.44 thorpej * corresponding NULL stub in if.c.
233 1.44 thorpej */
234 1.9 mycroft int (*if_output) /* output routine (enqueue) */
235 1.9 mycroft __P((struct ifnet *, struct mbuf *, struct sockaddr *,
236 1.9 mycroft struct rtentry *));
237 1.36 thorpej void (*if_input) /* input routine (from h/w driver) */
238 1.36 thorpej __P((struct ifnet *, struct mbuf *));
239 1.16 mycroft void (*if_start) /* initiate output routine */
240 1.9 mycroft __P((struct ifnet *));
241 1.9 mycroft int (*if_ioctl) /* ioctl routine */
242 1.13 cgd __P((struct ifnet *, u_long, caddr_t));
243 1.9 mycroft int (*if_reset) /* XXX bus reset routine */
244 1.23 thorpej __P((struct ifnet *));
245 1.16 mycroft void (*if_watchdog) /* timer routine */
246 1.32 matt __P((struct ifnet *));
247 1.32 matt void (*if_drain) /* routine to release resources */
248 1.23 thorpej __P((struct ifnet *));
249 1.1 cgd struct ifqueue {
250 1.1 cgd struct mbuf *ifq_head;
251 1.1 cgd struct mbuf *ifq_tail;
252 1.1 cgd int ifq_len;
253 1.1 cgd int ifq_maxlen;
254 1.1 cgd int ifq_drops;
255 1.1 cgd } if_snd; /* output queue */
256 1.26 is struct sockaddr_dl *if_sadl; /* pointer to our sockaddr_dl */
257 1.29 is u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
258 1.37 itojun struct ifprefix *if_prefixlist; /* linked list of prefixes per if */
259 1.1 cgd };
260 1.9 mycroft #define if_mtu if_data.ifi_mtu
261 1.9 mycroft #define if_type if_data.ifi_type
262 1.9 mycroft #define if_addrlen if_data.ifi_addrlen
263 1.9 mycroft #define if_hdrlen if_data.ifi_hdrlen
264 1.9 mycroft #define if_metric if_data.ifi_metric
265 1.46 thorpej #define if_link_state if_data.ifi_link_state
266 1.9 mycroft #define if_baudrate if_data.ifi_baudrate
267 1.9 mycroft #define if_ipackets if_data.ifi_ipackets
268 1.9 mycroft #define if_ierrors if_data.ifi_ierrors
269 1.9 mycroft #define if_opackets if_data.ifi_opackets
270 1.9 mycroft #define if_oerrors if_data.ifi_oerrors
271 1.9 mycroft #define if_collisions if_data.ifi_collisions
272 1.9 mycroft #define if_ibytes if_data.ifi_ibytes
273 1.9 mycroft #define if_obytes if_data.ifi_obytes
274 1.9 mycroft #define if_imcasts if_data.ifi_imcasts
275 1.9 mycroft #define if_omcasts if_data.ifi_omcasts
276 1.9 mycroft #define if_iqdrops if_data.ifi_iqdrops
277 1.9 mycroft #define if_noproto if_data.ifi_noproto
278 1.9 mycroft #define if_lastchange if_data.ifi_lastchange
279 1.1 cgd
280 1.1 cgd #define IFF_UP 0x1 /* interface is up */
281 1.1 cgd #define IFF_BROADCAST 0x2 /* broadcast address valid */
282 1.1 cgd #define IFF_DEBUG 0x4 /* turn on debugging */
283 1.1 cgd #define IFF_LOOPBACK 0x8 /* is a loopback net */
284 1.1 cgd #define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */
285 1.1 cgd #define IFF_NOTRAILERS 0x20 /* avoid use of trailers */
286 1.1 cgd #define IFF_RUNNING 0x40 /* resources allocated */
287 1.1 cgd #define IFF_NOARP 0x80 /* no address resolution protocol */
288 1.1 cgd #define IFF_PROMISC 0x100 /* receive all packets */
289 1.1 cgd #define IFF_ALLMULTI 0x200 /* receive all multicast packets */
290 1.1 cgd #define IFF_OACTIVE 0x400 /* transmission in progress */
291 1.1 cgd #define IFF_SIMPLEX 0x800 /* can't hear own transmissions */
292 1.5 cgd #define IFF_LINK0 0x1000 /* per link layer defined bit */
293 1.6 cgd #define IFF_LINK1 0x2000 /* per link layer defined bit */
294 1.6 cgd #define IFF_LINK2 0x4000 /* per link layer defined bit */
295 1.9 mycroft #define IFF_MULTICAST 0x8000 /* supports multicast */
296 1.4 hpeyerl
297 1.1 cgd /* flags set internally only: */
298 1.9 mycroft #define IFF_CANTCHANGE \
299 1.9 mycroft (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
300 1.52 thorpej IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_PROMISC)
301 1.1 cgd
302 1.1 cgd /*
303 1.46 thorpej * Some convenience macros used for setting ifi_baudrate.
304 1.46 thorpej * XXX 1000 vs. 1024? --thorpej (at) netbsd.org
305 1.46 thorpej */
306 1.46 thorpej #define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */
307 1.46 thorpej #define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */
308 1.46 thorpej #define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */
309 1.46 thorpej
310 1.46 thorpej /*
311 1.1 cgd * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
312 1.1 cgd * input routines have queues of messages stored on ifqueue structures
313 1.1 cgd * (defined above). Entries are added to and deleted from these structures
314 1.1 cgd * by these macros, which should be called with ipl raised to splimp().
315 1.1 cgd */
316 1.1 cgd #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
317 1.1 cgd #define IF_DROP(ifq) ((ifq)->ifq_drops++)
318 1.1 cgd #define IF_ENQUEUE(ifq, m) { \
319 1.1 cgd (m)->m_nextpkt = 0; \
320 1.1 cgd if ((ifq)->ifq_tail == 0) \
321 1.1 cgd (ifq)->ifq_head = m; \
322 1.1 cgd else \
323 1.1 cgd (ifq)->ifq_tail->m_nextpkt = m; \
324 1.1 cgd (ifq)->ifq_tail = m; \
325 1.1 cgd (ifq)->ifq_len++; \
326 1.1 cgd }
327 1.1 cgd #define IF_PREPEND(ifq, m) { \
328 1.1 cgd (m)->m_nextpkt = (ifq)->ifq_head; \
329 1.1 cgd if ((ifq)->ifq_tail == 0) \
330 1.1 cgd (ifq)->ifq_tail = (m); \
331 1.1 cgd (ifq)->ifq_head = (m); \
332 1.1 cgd (ifq)->ifq_len++; \
333 1.1 cgd }
334 1.1 cgd #define IF_DEQUEUE(ifq, m) { \
335 1.1 cgd (m) = (ifq)->ifq_head; \
336 1.1 cgd if (m) { \
337 1.1 cgd if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
338 1.1 cgd (ifq)->ifq_tail = 0; \
339 1.1 cgd (m)->m_nextpkt = 0; \
340 1.1 cgd (ifq)->ifq_len--; \
341 1.1 cgd } \
342 1.1 cgd }
343 1.1 cgd
344 1.1 cgd #define IFQ_MAXLEN 50
345 1.1 cgd #define IFNET_SLOWHZ 1 /* granularity is 1 second */
346 1.1 cgd
347 1.1 cgd /*
348 1.35 aidan * Structure defining statistics and other data kept regarding an address
349 1.35 aidan * on a network interface.
350 1.35 aidan */
351 1.35 aidan struct ifaddr_data {
352 1.35 aidan int64_t ifad_inbytes;
353 1.35 aidan int64_t ifad_outbytes;
354 1.35 aidan };
355 1.35 aidan
356 1.35 aidan /*
357 1.1 cgd * The ifaddr structure contains information about one address
358 1.1 cgd * of an interface. They are maintained by the different address families,
359 1.1 cgd * are allocated and attached when an address is set, and are linked
360 1.1 cgd * together so all addresses for an interface can be located.
361 1.1 cgd */
362 1.1 cgd struct ifaddr {
363 1.1 cgd struct sockaddr *ifa_addr; /* address of interface */
364 1.1 cgd struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
365 1.1 cgd #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
366 1.1 cgd struct sockaddr *ifa_netmask; /* used to determine subnet */
367 1.1 cgd struct ifnet *ifa_ifp; /* back-pointer to interface */
368 1.17 mycroft TAILQ_ENTRY(ifaddr) ifa_list; /* list of addresses for interface */
369 1.35 aidan struct ifaddr_data ifa_data; /* statistics on the address */
370 1.20 christos void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
371 1.20 christos __P((int, struct rtentry *, struct sockaddr *));
372 1.41 wrstuden u_int ifa_flags; /* mostly rt_flags for cloning */
373 1.41 wrstuden int ifa_refcnt; /* count of references */
374 1.9 mycroft int ifa_metric; /* cost of going out this interface */
375 1.1 cgd };
376 1.9 mycroft #define IFA_ROUTE RTF_UP /* route installed */
377 1.9 mycroft
378 1.9 mycroft /*
379 1.37 itojun * The prefix structure contains information about one prefix
380 1.37 itojun * of an interface. They are maintained by the different address families,
381 1.43 itojun * are allocated and attached when an prefix or an address is set,
382 1.37 itojun * and are linked together so all prfefixes for an interface can be located.
383 1.37 itojun */
384 1.37 itojun struct ifprefix {
385 1.37 itojun struct sockaddr *ifpr_prefix; /* prefix of interface */
386 1.37 itojun struct ifnet *ifpr_ifp; /* back-pointer to interface */
387 1.37 itojun struct ifprefix *ifpr_next;
388 1.37 itojun u_char ifpr_plen; /* prefix length in bits */
389 1.43 itojun u_char ifpr_type; /* protocol dependent prefix type */
390 1.37 itojun };
391 1.37 itojun
392 1.37 itojun /*
393 1.9 mycroft * Message format for use in obtaining information about interfaces
394 1.9 mycroft * from sysctl and the routing socket.
395 1.9 mycroft */
396 1.9 mycroft struct if_msghdr {
397 1.9 mycroft u_short ifm_msglen; /* to skip over non-understood messages */
398 1.9 mycroft u_char ifm_version; /* future binary compatability */
399 1.9 mycroft u_char ifm_type; /* message type */
400 1.9 mycroft int ifm_addrs; /* like rtm_addrs */
401 1.9 mycroft int ifm_flags; /* value of if_flags */
402 1.9 mycroft u_short ifm_index; /* index for associated ifp */
403 1.9 mycroft struct if_data ifm_data;/* statistics and other data about if */
404 1.9 mycroft };
405 1.42 bouyer
406 1.45 kleink #if defined(_KERNEL) && defined(COMPAT_14)
407 1.42 bouyer /* pre-1.5 if_msghdr (ifm_data changed) */
408 1.42 bouyer struct if_msghdr14 {
409 1.42 bouyer u_short ifm_msglen; /* to skip over non-understood messages */
410 1.42 bouyer u_char ifm_version; /* future binary compatability */
411 1.42 bouyer u_char ifm_type; /* message type */
412 1.42 bouyer int ifm_addrs; /* like rtm_addrs */
413 1.42 bouyer int ifm_flags; /* value of if_flags */
414 1.42 bouyer u_short ifm_index; /* index for associated ifp */
415 1.42 bouyer struct if_data14 ifm_data; /* statistics and other data about if */
416 1.42 bouyer };
417 1.45 kleink #endif /* _KERNEL && COMPAT_14 */
418 1.9 mycroft
419 1.9 mycroft /*
420 1.9 mycroft * Message format for use in obtaining information about interface addresses
421 1.9 mycroft * from sysctl and the routing socket.
422 1.9 mycroft */
423 1.9 mycroft struct ifa_msghdr {
424 1.9 mycroft u_short ifam_msglen; /* to skip over non-understood messages */
425 1.9 mycroft u_char ifam_version; /* future binary compatability */
426 1.9 mycroft u_char ifam_type; /* message type */
427 1.9 mycroft int ifam_addrs; /* like rtm_addrs */
428 1.9 mycroft int ifam_flags; /* value of ifa_flags */
429 1.9 mycroft u_short ifam_index; /* index for associated ifp */
430 1.9 mycroft int ifam_metric; /* value of ifa_metric */
431 1.9 mycroft };
432 1.46 thorpej
433 1.46 thorpej /*
434 1.46 thorpej * Message format announcing the arrival or departure of a network interface.
435 1.46 thorpej */
436 1.46 thorpej struct if_announcemsghdr {
437 1.46 thorpej u_short ifan_msglen; /* to skip over non-understood messages */
438 1.46 thorpej u_char ifan_version; /* future binary compatibility */
439 1.46 thorpej u_char ifan_type; /* message type */
440 1.46 thorpej u_short ifan_index; /* index for associated ifp */
441 1.46 thorpej char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
442 1.46 thorpej u_short ifan_what; /* what type of announcement */
443 1.46 thorpej };
444 1.46 thorpej
445 1.46 thorpej #define IFAN_ARRIVAL 0 /* interface arrival */
446 1.46 thorpej #define IFAN_DEPARTURE 1 /* interface departure */
447 1.9 mycroft
448 1.1 cgd /*
449 1.1 cgd * Interface request structure used for socket
450 1.1 cgd * ioctl's. All interface ioctl's must have parameter
451 1.1 cgd * definitions which begin with ifr_name. The
452 1.1 cgd * remainder may be interface specific.
453 1.1 cgd */
454 1.1 cgd struct ifreq {
455 1.1 cgd char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */
456 1.1 cgd union {
457 1.1 cgd struct sockaddr ifru_addr;
458 1.1 cgd struct sockaddr ifru_dstaddr;
459 1.1 cgd struct sockaddr ifru_broadaddr;
460 1.1 cgd short ifru_flags;
461 1.1 cgd int ifru_metric;
462 1.24 cgd int ifru_mtu;
463 1.39 matt u_int ifru_value;
464 1.1 cgd caddr_t ifru_data;
465 1.1 cgd } ifr_ifru;
466 1.1 cgd #define ifr_addr ifr_ifru.ifru_addr /* address */
467 1.1 cgd #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */
468 1.1 cgd #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
469 1.1 cgd #define ifr_flags ifr_ifru.ifru_flags /* flags */
470 1.1 cgd #define ifr_metric ifr_ifru.ifru_metric /* metric */
471 1.24 cgd #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
472 1.39 matt #define ifr_value ifr_ifru.ifru_value /* generic value */
473 1.27 thorpej #define ifr_media ifr_ifru.ifru_metric /* media options (overload) */
474 1.1 cgd #define ifr_data ifr_ifru.ifru_data /* for use by interface */
475 1.50 itojun };
476 1.1 cgd
477 1.1 cgd struct ifaliasreq {
478 1.1 cgd char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
479 1.1 cgd struct sockaddr ifra_addr;
480 1.21 pk struct sockaddr ifra_dstaddr;
481 1.21 pk #define ifra_broadaddr ifra_dstaddr
482 1.1 cgd struct sockaddr ifra_mask;
483 1.27 thorpej };
484 1.27 thorpej
485 1.27 thorpej struct ifmediareq {
486 1.27 thorpej char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */
487 1.27 thorpej int ifm_current; /* current media options */
488 1.27 thorpej int ifm_mask; /* don't care mask */
489 1.27 thorpej int ifm_status; /* media status */
490 1.27 thorpej int ifm_active; /* active options */
491 1.27 thorpej int ifm_count; /* # entries in ifm_ulist
492 1.27 thorpej array */
493 1.27 thorpej int *ifm_ulist; /* media words */
494 1.1 cgd };
495 1.31 kml
496 1.31 kml
497 1.31 kml struct ifdrv {
498 1.31 kml char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */
499 1.31 kml unsigned long ifd_cmd;
500 1.31 kml size_t ifd_len;
501 1.31 kml void *ifd_data;
502 1.31 kml };
503 1.1 cgd
504 1.1 cgd /*
505 1.1 cgd * Structure used in SIOCGIFCONF request.
506 1.1 cgd * Used to retrieve interface configuration
507 1.1 cgd * for machine (useful for programs which
508 1.1 cgd * must know all networks accessible).
509 1.1 cgd */
510 1.1 cgd struct ifconf {
511 1.1 cgd int ifc_len; /* size of associated buffer */
512 1.1 cgd union {
513 1.1 cgd caddr_t ifcu_buf;
514 1.1 cgd struct ifreq *ifcu_req;
515 1.1 cgd } ifc_ifcu;
516 1.1 cgd #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
517 1.1 cgd #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */
518 1.1 cgd };
519 1.1 cgd
520 1.37 itojun /*
521 1.37 itojun * Structure for SIOC[AGD]LIFADDR
522 1.37 itojun */
523 1.37 itojun struct if_laddrreq {
524 1.37 itojun char iflr_name[IFNAMSIZ];
525 1.37 itojun unsigned int flags;
526 1.37 itojun #define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */
527 1.37 itojun unsigned int prefixlen; /* in/out */
528 1.37 itojun struct sockaddr_storage addr; /* in/out */
529 1.37 itojun struct sockaddr_storage dstaddr; /* out */
530 1.37 itojun };
531 1.37 itojun
532 1.9 mycroft #include <net/if_arp.h>
533 1.9 mycroft
534 1.38 kleink #endif /* !_XOPEN_SOURCE */
535 1.38 kleink
536 1.15 jtc #ifdef _KERNEL
537 1.44 thorpej #ifdef IFAREF_DEBUG
538 1.44 thorpej #define IFAREF(ifa) \
539 1.44 thorpej do { \
540 1.44 thorpej printf("IFAREF: %s:%d %p -> %d\n", __FILE__, __LINE__, \
541 1.44 thorpej (ifa), ++(ifa)->ifa_refcnt); \
542 1.44 thorpej } while (0)
543 1.44 thorpej
544 1.44 thorpej #define IFAFREE(ifa) \
545 1.44 thorpej do { \
546 1.44 thorpej if ((ifa)->ifa_refcnt <= 0) \
547 1.44 thorpej panic("%s:%d: %p ifa_refcnt <= 0", __FILE__, \
548 1.44 thorpej __LINE__, (ifa)); \
549 1.44 thorpej printf("IFAFREE: %s:%d %p -> %d\n", __FILE__, __LINE__, \
550 1.44 thorpej (ifa), --(ifa)->ifa_refcnt); \
551 1.44 thorpej if ((ifa)->ifa_refcnt == 0) \
552 1.44 thorpej ifafree(ifa); \
553 1.44 thorpej } while (0)
554 1.44 thorpej #else
555 1.44 thorpej #define IFAREF(ifa) (ifa)->ifa_refcnt++
556 1.44 thorpej
557 1.44 thorpej #ifdef DIAGNOSTIC
558 1.44 thorpej #define IFAFREE(ifa) \
559 1.44 thorpej do { \
560 1.44 thorpej if ((ifa)->ifa_refcnt <= 0) \
561 1.44 thorpej panic("%s:%d: %p ifa_refcnt <= 0", __FILE__, \
562 1.44 thorpej __LINE__, (ifa)); \
563 1.44 thorpej if (--(ifa)->ifa_refcnt == 0) \
564 1.44 thorpej ifafree(ifa); \
565 1.44 thorpej } while (0)
566 1.44 thorpej #else
567 1.44 thorpej #define IFAFREE(ifa) \
568 1.44 thorpej do { \
569 1.44 thorpej if (--(ifa)->ifa_refcnt == 0) \
570 1.44 thorpej ifafree(ifa); \
571 1.44 thorpej } while (0)
572 1.44 thorpej #endif /* DIAGNOSTIC */
573 1.44 thorpej #endif /* IFAREF_DEBUG */
574 1.9 mycroft
575 1.19 cgd struct ifnet_head ifnet;
576 1.48 simonb extern struct ifnet **ifindex2ifnet;
577 1.37 itojun #if 0
578 1.37 itojun struct ifnet loif[];
579 1.37 itojun #endif
580 1.48 simonb extern int if_index;
581 1.2 mycroft
582 1.34 thorpej void ether_ifattach __P((struct ifnet *, const u_int8_t *));
583 1.44 thorpej void ether_ifdetach __P((struct ifnet *));
584 1.33 thorpej char *ether_sprintf __P((const u_char *));
585 1.9 mycroft
586 1.9 mycroft void if_attach __P((struct ifnet *));
587 1.44 thorpej void if_deactivate __P((struct ifnet *));
588 1.44 thorpej void if_detach __P((struct ifnet *));
589 1.9 mycroft void if_down __P((struct ifnet *));
590 1.9 mycroft void if_qflush __P((struct ifqueue *));
591 1.9 mycroft void if_slowtimo __P((void *));
592 1.9 mycroft void if_up __P((struct ifnet *));
593 1.14 cgd int ifconf __P((u_long, caddr_t));
594 1.9 mycroft void ifinit __P((void));
595 1.13 cgd int ifioctl __P((struct socket *, u_long, caddr_t, struct proc *));
596 1.9 mycroft int ifpromisc __P((struct ifnet *, int));
597 1.40 thorpej struct ifnet *ifunit __P((const char *));
598 1.9 mycroft
599 1.9 mycroft struct ifaddr *ifa_ifwithaddr __P((struct sockaddr *));
600 1.9 mycroft struct ifaddr *ifa_ifwithaf __P((int));
601 1.9 mycroft struct ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *));
602 1.9 mycroft struct ifaddr *ifa_ifwithnet __P((struct sockaddr *));
603 1.22 mrg struct ifaddr *ifa_ifwithladdr __P((struct sockaddr *));
604 1.9 mycroft struct ifaddr *ifa_ifwithroute __P((int, struct sockaddr *,
605 1.9 mycroft struct sockaddr *));
606 1.9 mycroft struct ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *));
607 1.9 mycroft void ifafree __P((struct ifaddr *));
608 1.9 mycroft void link_rtrequest __P((int, struct rtentry *, struct sockaddr *));
609 1.51 thorpej
610 1.51 thorpej void if_clone_attach __P((struct if_clone *));
611 1.51 thorpej void if_clone_detach __P((struct if_clone *));
612 1.51 thorpej
613 1.51 thorpej int if_clone_create __P((const char *));
614 1.51 thorpej int if_clone_destroy __P((const char *));
615 1.9 mycroft
616 1.13 cgd int loioctl __P((struct ifnet *, u_long, caddr_t));
617 1.9 mycroft void loopattach __P((int));
618 1.9 mycroft int looutput __P((struct ifnet *,
619 1.9 mycroft struct mbuf *, struct sockaddr *, struct rtentry *));
620 1.9 mycroft void lortrequest __P((int, struct rtentry *, struct sockaddr *));
621 1.44 thorpej
622 1.44 thorpej /*
623 1.44 thorpej * These are exported because they're an easy way to tell if
624 1.44 thorpej * an interface is going away without having to burn a flag.
625 1.44 thorpej */
626 1.44 thorpej int if_nulloutput __P((struct ifnet *, struct mbuf *,
627 1.44 thorpej struct sockaddr *, struct rtentry *));
628 1.44 thorpej void if_nullinput __P((struct ifnet *, struct mbuf *));
629 1.44 thorpej void if_nullstart __P((struct ifnet *));
630 1.44 thorpej int if_nullioctl __P((struct ifnet *, u_long, caddr_t));
631 1.44 thorpej int if_nullreset __P((struct ifnet *));
632 1.44 thorpej void if_nullwatchdog __P((struct ifnet *));
633 1.44 thorpej void if_nulldrain __P((struct ifnet *));
634 1.37 itojun #else
635 1.37 itojun struct if_nameindex {
636 1.37 itojun unsigned int if_index; /* 1, 2, ... */
637 1.37 itojun char *if_name; /* null terminated name: "le0", ... */
638 1.37 itojun };
639 1.37 itojun
640 1.38 kleink #include <sys/cdefs.h>
641 1.37 itojun __BEGIN_DECLS
642 1.37 itojun unsigned int if_nametoindex __P((const char *));
643 1.38 kleink char * if_indextoname __P((unsigned int, char *));
644 1.38 kleink struct if_nameindex * if_nameindex __P((void));
645 1.38 kleink void if_freenameindex __P((struct if_nameindex *));
646 1.37 itojun __END_DECLS
647 1.15 jtc #endif /* _KERNEL */
648 1.28 chuck #endif /* !_NET_IF_H_ */
649