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