if.h revision 1.120 1 /* $NetBSD: if.h,v 1.120 2006/11/13 05:13:40 dyoung 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 #endif
126
127 struct mbuf;
128 struct proc;
129 struct rtentry;
130 struct socket;
131 struct ether_header;
132 struct ifaddr;
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 { { NULL, NULL }, 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 (struct ifnet *, struct mbuf *, struct sockaddr *,
259 struct rtentry *);
260 void (*if_input) /* input routine (from h/w driver) */
261 (struct ifnet *, struct mbuf *);
262 void (*if_start) /* initiate output routine */
263 (struct ifnet *);
264 int (*if_ioctl) /* ioctl routine */
265 (struct ifnet *, u_long, caddr_t);
266 int (*if_init) /* init routine */
267 (struct ifnet *);
268 void (*if_stop) /* stop routine */
269 (struct ifnet *, int);
270 void (*if_watchdog) /* timer routine */
271 (struct ifnet *);
272 void (*if_drain) /* routine to release resources */
273 (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 union {
283 caddr_t carp_s; /* carp structure (used by !carp ifs) */
284 struct ifnet *carp_d;/* ptr to carpdev (used by carp ifs) */
285 } if_carp_ptr;
286 #define if_carp if_carp_ptr.carp_s
287 #define if_carpdev if_carp_ptr.carp_d
288 /*
289 * These are pre-computed based on an interfaces enabled
290 * capabilities, for speed elsewhere.
291 */
292 int if_csum_flags_tx; /* M_CSUM_* flags for Tx */
293 int if_csum_flags_rx; /* M_CSUM_* flags for Rx */
294
295 void *if_afdata[AF_MAX];
296 struct mowner *if_mowner; /* who owns mbufs for this interface */
297
298 void *if_agrprivate; /* used only when #if NAGR > 0 */
299 };
300 #define if_mtu if_data.ifi_mtu
301 #define if_type if_data.ifi_type
302 #define if_addrlen if_data.ifi_addrlen
303 #define if_hdrlen if_data.ifi_hdrlen
304 #define if_metric if_data.ifi_metric
305 #define if_link_state if_data.ifi_link_state
306 #define if_baudrate if_data.ifi_baudrate
307 #define if_ipackets if_data.ifi_ipackets
308 #define if_ierrors if_data.ifi_ierrors
309 #define if_opackets if_data.ifi_opackets
310 #define if_oerrors if_data.ifi_oerrors
311 #define if_collisions if_data.ifi_collisions
312 #define if_ibytes if_data.ifi_ibytes
313 #define if_obytes if_data.ifi_obytes
314 #define if_imcasts if_data.ifi_imcasts
315 #define if_omcasts if_data.ifi_omcasts
316 #define if_iqdrops if_data.ifi_iqdrops
317 #define if_noproto if_data.ifi_noproto
318 #define if_lastchange if_data.ifi_lastchange
319
320 #define IFF_UP 0x0001 /* interface is up */
321 #define IFF_BROADCAST 0x0002 /* broadcast address valid */
322 #define IFF_DEBUG 0x0004 /* turn on debugging */
323 #define IFF_LOOPBACK 0x0008 /* is a loopback net */
324 #define IFF_POINTOPOINT 0x0010 /* interface is point-to-point link */
325 #define IFF_NOTRAILERS 0x0020 /* avoid use of trailers */
326 #define IFF_RUNNING 0x0040 /* resources allocated */
327 #define IFF_NOARP 0x0080 /* no address resolution protocol */
328 #define IFF_PROMISC 0x0100 /* receive all packets */
329 #define IFF_ALLMULTI 0x0200 /* receive all multicast packets */
330 #define IFF_OACTIVE 0x0400 /* transmission in progress */
331 #define IFF_SIMPLEX 0x0800 /* can't hear own transmissions */
332 #define IFF_LINK0 0x1000 /* per link layer defined bit */
333 #define IFF_LINK1 0x2000 /* per link layer defined bit */
334 #define IFF_LINK2 0x4000 /* per link layer defined bit */
335 #define IFF_MULTICAST 0x8000 /* supports multicast */
336
337 #define IFFBITS \
338 "\020\1UP\2BROADCAST\3DEBUG\4LOOPBACK\5POINTOPOINT\6NOTRAILERS" \
339 "\7RUNNING\10NOARP\11PROMISC\12ALLMULTI\13OACTIVE\14SIMPLEX" \
340 "\15LINK0\16LINK1\17LINK2\20MULTICAST"
341
342 /* flags set internally only: */
343 #define IFF_CANTCHANGE \
344 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
345 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_PROMISC)
346
347 /*
348 * Some convenience macros used for setting ifi_baudrate.
349 * XXX 1000 vs. 1024? --thorpej (at) NetBSD.org
350 */
351 #define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */
352 #define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */
353 #define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */
354
355 /* Capabilities that interfaces can advertise. */
356 #define IFCAP_TSOv4 0x00080 /* can do TCPv4 segmentation offload */
357 #define IFCAP_CSUM_IPv4_Rx 0x00100 /* can do IPv4 header checksums (Rx) */
358 #define IFCAP_CSUM_IPv4_Tx 0x00200 /* can do IPv4 header checksums (Tx) */
359 #define IFCAP_CSUM_TCPv4_Rx 0x00400 /* can do IPv4/TCP checksums (Rx) */
360 #define IFCAP_CSUM_TCPv4_Tx 0x00800 /* can do IPv4/TCP checksums (Tx) */
361 #define IFCAP_CSUM_UDPv4_Rx 0x01000 /* can do IPv4/UDP checksums (Rx) */
362 #define IFCAP_CSUM_UDPv4_Tx 0x02000 /* can do IPv4/UDP checksums (Tx) */
363 #define IFCAP_CSUM_TCPv6_Rx 0x04000 /* can do IPv6/TCP checksums (Rx) */
364 #define IFCAP_CSUM_TCPv6_Tx 0x08000 /* can do IPv6/TCP checksums (Tx) */
365 #define IFCAP_CSUM_UDPv6_Rx 0x10000 /* can do IPv6/UDP checksums (Rx) */
366 #define IFCAP_CSUM_UDPv6_Tx 0x20000 /* can do IPv6/UDP checksums (Tx) */
367
368 #define IFCAPBITS \
369 "\020" \
370 "\10TSO4" \
371 "\11IP4CSUM_Rx" \
372 "\12IP4CSUM_Tx" \
373 "\13TCP4CSUM_Rx" \
374 "\14TCP4CSUM_Tx" \
375 "\15UDP4CSUM_Rx" \
376 "\16UDP4CSUM_Tx" \
377 "\17TCP6CSUM_Rx" \
378 "\20TCP6CSUM_Tx" \
379 "\21UDP6CSUM_Rx" \
380 "\22UDP6CSUM_Tx"
381
382 /*
383 * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
384 * input routines have queues of messages stored on ifqueue structures
385 * (defined above). Entries are added to and deleted from these structures
386 * by these macros, which should be called with ipl raised to splnet().
387 */
388 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
389 #define IF_DROP(ifq) ((ifq)->ifq_drops++)
390 #define IF_ENQUEUE(ifq, m) do { \
391 (m)->m_nextpkt = 0; \
392 if ((ifq)->ifq_tail == 0) \
393 (ifq)->ifq_head = m; \
394 else \
395 (ifq)->ifq_tail->m_nextpkt = m; \
396 (ifq)->ifq_tail = m; \
397 (ifq)->ifq_len++; \
398 } while (/*CONSTCOND*/0)
399 #define IF_PREPEND(ifq, m) do { \
400 (m)->m_nextpkt = (ifq)->ifq_head; \
401 if ((ifq)->ifq_tail == 0) \
402 (ifq)->ifq_tail = (m); \
403 (ifq)->ifq_head = (m); \
404 (ifq)->ifq_len++; \
405 } while (/*CONSTCOND*/0)
406 #define IF_DEQUEUE(ifq, m) do { \
407 (m) = (ifq)->ifq_head; \
408 if (m) { \
409 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
410 (ifq)->ifq_tail = 0; \
411 (m)->m_nextpkt = 0; \
412 (ifq)->ifq_len--; \
413 } \
414 } while (/*CONSTCOND*/0)
415 #define IF_POLL(ifq, m) ((m) = (ifq)->ifq_head)
416 #define IF_PURGE(ifq) \
417 do { \
418 struct mbuf *__m0; \
419 \
420 for (;;) { \
421 IF_DEQUEUE((ifq), __m0); \
422 if (__m0 == NULL) \
423 break; \
424 else \
425 m_freem(__m0); \
426 } \
427 } while (/*CONSTCOND*/ 0)
428 #define IF_IS_EMPTY(ifq) ((ifq)->ifq_len == 0)
429
430 #ifndef IFQ_MAXLEN
431 #define IFQ_MAXLEN 256
432 #endif
433 #define IFNET_SLOWHZ 1 /* granularity is 1 second */
434
435 /*
436 * Structure defining statistics and other data kept regarding an address
437 * on a network interface.
438 */
439 struct ifaddr_data {
440 int64_t ifad_inbytes;
441 int64_t ifad_outbytes;
442 };
443
444 /*
445 * The ifaddr structure contains information about one address
446 * of an interface. They are maintained by the different address families,
447 * are allocated and attached when an address is set, and are linked
448 * together so all addresses for an interface can be located.
449 */
450 struct ifaddr {
451 struct sockaddr *ifa_addr; /* address of interface */
452 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
453 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
454 struct sockaddr *ifa_netmask; /* used to determine subnet */
455 struct ifnet *ifa_ifp; /* back-pointer to interface */
456 TAILQ_ENTRY(ifaddr) ifa_list; /* list of addresses for interface */
457 struct ifaddr_data ifa_data; /* statistics on the address */
458 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
459 (int, struct rtentry *, struct rt_addrinfo *);
460 u_int ifa_flags; /* mostly rt_flags for cloning */
461 int ifa_refcnt; /* count of references */
462 int ifa_metric; /* cost of going out this interface */
463 struct ifaddr *(*ifa_getifa)(struct ifaddr *,
464 const struct sockaddr *);
465 uint32_t *ifa_seqno;
466 int16_t ifa_preference; /* preference level for this address */
467 };
468 #define IFA_ROUTE RTF_UP /* 0x01 *//* route installed */
469
470 /*
471 * Message format for use in obtaining information about interfaces
472 * from sysctl and the routing socket.
473 */
474 struct if_msghdr {
475 u_short ifm_msglen; /* to skip over non-understood messages */
476 u_char ifm_version; /* future binary compatibility */
477 u_char ifm_type; /* message type */
478 int ifm_addrs; /* like rtm_addrs */
479 int ifm_flags; /* value of if_flags */
480 u_short ifm_index; /* index for associated ifp */
481 struct if_data ifm_data;/* statistics and other data about if */
482 };
483
484 #if defined(_KERNEL) && defined(COMPAT_14)
485 /* pre-1.5 if_msghdr (ifm_data changed) */
486 struct if_msghdr14 {
487 u_short ifm_msglen; /* to skip over non-understood messages */
488 u_char ifm_version; /* future binary compatibility */
489 u_char ifm_type; /* message type */
490 int ifm_addrs; /* like rtm_addrs */
491 int ifm_flags; /* value of if_flags */
492 u_short ifm_index; /* index for associated ifp */
493 struct if_data14 ifm_data; /* statistics and other data about if */
494 };
495 #endif /* _KERNEL && COMPAT_14 */
496
497 /*
498 * Message format for use in obtaining information about interface addresses
499 * from sysctl and the routing socket.
500 */
501 struct ifa_msghdr {
502 u_short ifam_msglen; /* to skip over non-understood messages */
503 u_char ifam_version; /* future binary compatibility */
504 u_char ifam_type; /* message type */
505 int ifam_addrs; /* like rtm_addrs */
506 int ifam_flags; /* value of ifa_flags */
507 u_short ifam_index; /* index for associated ifp */
508 int ifam_metric; /* value of ifa_metric */
509 };
510
511 /*
512 * Message format announcing the arrival or departure of a network interface.
513 */
514 struct if_announcemsghdr {
515 u_short ifan_msglen; /* to skip over non-understood messages */
516 u_char ifan_version; /* future binary compatibility */
517 u_char ifan_type; /* message type */
518 u_short ifan_index; /* index for associated ifp */
519 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
520 u_short ifan_what; /* what type of announcement */
521 };
522
523 #define IFAN_ARRIVAL 0 /* interface arrival */
524 #define IFAN_DEPARTURE 1 /* interface departure */
525
526 /*
527 * Interface request structure used for socket
528 * ioctl's. All interface ioctl's must have parameter
529 * definitions which begin with ifr_name. The
530 * remainder may be interface specific.
531 */
532 struct ifreq {
533 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */
534 union {
535 struct sockaddr ifru_addr;
536 struct sockaddr ifru_dstaddr;
537 struct sockaddr ifru_broadaddr;
538 short ifru_flags;
539 int ifru_metric;
540 int ifru_mtu;
541 int ifru_dlt;
542 u_int ifru_value;
543 caddr_t ifru_data;
544 struct {
545 uint32_t b_buflen;
546 void *b_buf;
547 } ifru_b;
548 } ifr_ifru;
549 #define ifr_addr ifr_ifru.ifru_addr /* address */
550 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */
551 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
552 #define ifr_flags ifr_ifru.ifru_flags /* flags */
553 #define ifr_metric ifr_ifru.ifru_metric /* metric */
554 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
555 #define ifr_dlt ifr_ifru.ifru_dlt /* data link type (DLT_*) */
556 #define ifr_value ifr_ifru.ifru_value /* generic value */
557 #define ifr_media ifr_ifru.ifru_metric /* media options (overload) */
558 #define ifr_data ifr_ifru.ifru_data /* for use by interface
559 * XXX deprecated
560 */
561 #define ifr_buf ifr_ifru.ifru_b.b_buf /* new interface ioctls */
562 #define ifr_buflen ifr_ifru.ifru_b.b_buflen
563 };
564
565 struct ifcapreq {
566 char ifcr_name[IFNAMSIZ]; /* if name, e.g. "en0" */
567 uint64_t ifcr_capabilities; /* supported capabiliites */
568 uint64_t ifcr_capenable; /* capabilities enabled */
569 };
570
571 struct ifaliasreq {
572 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
573 struct sockaddr ifra_addr;
574 struct sockaddr ifra_dstaddr;
575 #define ifra_broadaddr ifra_dstaddr
576 struct sockaddr ifra_mask;
577 };
578
579 struct ifdatareq {
580 char ifdr_name[IFNAMSIZ]; /* if name, e.g. "en0" */
581 struct if_data ifdr_data;
582 };
583
584 struct ifmediareq {
585 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */
586 int ifm_current; /* current media options */
587 int ifm_mask; /* don't care mask */
588 int ifm_status; /* media status */
589 int ifm_active; /* active options */
590 int ifm_count; /* # entries in ifm_ulist
591 array */
592 int *ifm_ulist; /* media words */
593 };
594
595
596 struct ifdrv {
597 char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */
598 unsigned long ifd_cmd;
599 size_t ifd_len;
600 void *ifd_data;
601 };
602
603 /*
604 * Structure used in SIOCGIFCONF request.
605 * Used to retrieve interface configuration
606 * for machine (useful for programs which
607 * must know all networks accessible).
608 */
609 struct ifconf {
610 int ifc_len; /* size of associated buffer */
611 union {
612 caddr_t ifcu_buf;
613 struct ifreq *ifcu_req;
614 } ifc_ifcu;
615 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
616 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */
617 };
618
619 /*
620 * Structure for SIOC[AGD]LIFADDR
621 */
622 struct if_laddrreq {
623 char iflr_name[IFNAMSIZ];
624 unsigned int flags;
625 #define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */
626 unsigned int prefixlen; /* in/out */
627 struct sockaddr_storage addr; /* in/out */
628 struct sockaddr_storage dstaddr; /* out */
629 };
630
631 /*
632 * Structure for SIOC[SG]IFADDRPREF
633 */
634 struct if_addrprefreq {
635 char ifap_name[IFNAMSIZ];
636 int16_t ifap_preference; /* in/out */
637 struct sockaddr_storage ifap_addr; /* in/out */
638 };
639
640 #include <net/if_arp.h>
641
642 #endif /* _NETBSD_SOURCE */
643
644 #ifdef _KERNEL
645 #ifdef IFAREF_DEBUG
646 #define IFAREF(ifa) \
647 do { \
648 printf("IFAREF: %s:%d %p -> %d\n", __FILE__, __LINE__, \
649 (ifa), ++(ifa)->ifa_refcnt); \
650 } while (/*CONSTCOND*/ 0)
651
652 #define IFAFREE(ifa) \
653 do { \
654 if ((ifa)->ifa_refcnt <= 0) \
655 panic("%s:%d: %p ifa_refcnt <= 0", __FILE__, \
656 __LINE__, (ifa)); \
657 printf("IFAFREE: %s:%d %p -> %d\n", __FILE__, __LINE__, \
658 (ifa), --(ifa)->ifa_refcnt); \
659 if ((ifa)->ifa_refcnt == 0) \
660 ifafree(ifa); \
661 } while (/*CONSTCOND*/ 0)
662 #else
663 #define IFAREF(ifa) (ifa)->ifa_refcnt++
664
665 #ifdef DIAGNOSTIC
666 #define IFAFREE(ifa) \
667 do { \
668 if ((ifa)->ifa_refcnt <= 0) \
669 panic("%s:%d: %p ifa_refcnt <= 0", __FILE__, \
670 __LINE__, (ifa)); \
671 if (--(ifa)->ifa_refcnt == 0) \
672 ifafree(ifa); \
673 } while (/*CONSTCOND*/ 0)
674 #else
675 #define IFAFREE(ifa) \
676 do { \
677 if (--(ifa)->ifa_refcnt == 0) \
678 ifafree(ifa); \
679 } while (/*CONSTCOND*/ 0)
680 #endif /* DIAGNOSTIC */
681 #endif /* IFAREF_DEBUG */
682
683 #ifdef ALTQ
684 #define ALTQ_DECL(x) x
685 #define ALTQ_COMMA ,
686
687 #define IFQ_ENQUEUE(ifq, m, pattr, err) \
688 do { \
689 if (ALTQ_IS_ENABLED((ifq))) \
690 ALTQ_ENQUEUE((ifq), (m), (pattr), (err)); \
691 else { \
692 if (IF_QFULL((ifq))) { \
693 m_freem((m)); \
694 (err) = ENOBUFS; \
695 } else { \
696 IF_ENQUEUE((ifq), (m)); \
697 (err) = 0; \
698 } \
699 } \
700 if ((err)) \
701 (ifq)->ifq_drops++; \
702 } while (/*CONSTCOND*/ 0)
703
704 #define IFQ_DEQUEUE(ifq, m) \
705 do { \
706 if (TBR_IS_ENABLED((ifq))) \
707 (m) = tbr_dequeue((ifq), ALTDQ_REMOVE); \
708 else if (ALTQ_IS_ENABLED((ifq))) \
709 ALTQ_DEQUEUE((ifq), (m)); \
710 else \
711 IF_DEQUEUE((ifq), (m)); \
712 } while (/*CONSTCOND*/ 0)
713
714 #define IFQ_POLL(ifq, m) \
715 do { \
716 if (TBR_IS_ENABLED((ifq))) \
717 (m) = tbr_dequeue((ifq), ALTDQ_POLL); \
718 else if (ALTQ_IS_ENABLED((ifq))) \
719 ALTQ_POLL((ifq), (m)); \
720 else \
721 IF_POLL((ifq), (m)); \
722 } while (/*CONSTCOND*/ 0)
723
724 #define IFQ_PURGE(ifq) \
725 do { \
726 if (ALTQ_IS_ENABLED((ifq))) \
727 ALTQ_PURGE((ifq)); \
728 else \
729 IF_PURGE((ifq)); \
730 } while (/*CONSTCOND*/ 0)
731
732 #define IFQ_SET_READY(ifq) \
733 do { \
734 (ifq)->altq_flags |= ALTQF_READY; \
735 } while (/*CONSTCOND*/ 0)
736
737 #define IFQ_CLASSIFY(ifq, m, af, pattr) \
738 do { \
739 if (ALTQ_IS_ENABLED((ifq))) { \
740 if (ALTQ_NEEDS_CLASSIFY((ifq))) \
741 (pattr)->pattr_class = (*(ifq)->altq_classify) \
742 ((ifq)->altq_clfier, (m), (af)); \
743 (pattr)->pattr_af = (af); \
744 (pattr)->pattr_hdr = mtod((m), caddr_t); \
745 } \
746 } while (/*CONSTCOND*/ 0)
747 #else /* ! ALTQ */
748 #define ALTQ_DECL(x) /* nothing */
749 #define ALTQ_COMMA
750
751 #define IFQ_ENQUEUE(ifq, m, pattr, err) \
752 do { \
753 if (IF_QFULL((ifq))) { \
754 m_freem((m)); \
755 (err) = ENOBUFS; \
756 } else { \
757 IF_ENQUEUE((ifq), (m)); \
758 (err) = 0; \
759 } \
760 if ((err)) \
761 (ifq)->ifq_drops++; \
762 } while (/*CONSTCOND*/ 0)
763
764 #define IFQ_DEQUEUE(ifq, m) IF_DEQUEUE((ifq), (m))
765
766 #define IFQ_POLL(ifq, m) IF_POLL((ifq), (m))
767
768 #define IFQ_PURGE(ifq) IF_PURGE((ifq))
769
770 #define IFQ_SET_READY(ifq) /* nothing */
771
772 #define IFQ_CLASSIFY(ifq, m, af, pattr) /* nothing */
773
774 #endif /* ALTQ */
775
776 #define IFQ_IS_EMPTY(ifq) IF_IS_EMPTY((ifq))
777 #define IFQ_INC_LEN(ifq) ((ifq)->ifq_len++)
778 #define IFQ_DEC_LEN(ifq) (--(ifq)->ifq_len)
779 #define IFQ_INC_DROPS(ifq) ((ifq)->ifq_drops++)
780 #define IFQ_SET_MAXLEN(ifq, len) ((ifq)->ifq_maxlen = (len))
781
782 #include <sys/mallocvar.h>
783 MALLOC_DECLARE(M_IFADDR);
784 MALLOC_DECLARE(M_IFMADDR);
785
786 #define IFNET_FOREACH(ifp) TAILQ_FOREACH(ifp, &ifnet, if_list)
787 #define IFADDR_FOREACH(ifa, ifp) TAILQ_FOREACH(ifa, \
788 &(ifp)->if_addrlist, ifa_list)
789
790 extern struct ifnet_head ifnet;
791 extern struct ifnet **ifindex2ifnet;
792 extern struct ifnet *lo0ifp;
793 extern size_t if_indexlim;
794
795 void ether_input(struct ifnet *, struct mbuf *);
796
797 void if_alloc_sadl(struct ifnet *);
798 void if_free_sadl(struct ifnet *);
799 void if_attach(struct ifnet *);
800 void if_attachdomain(void);
801 void if_attachdomain1(struct ifnet *);
802 void if_deactivate(struct ifnet *);
803 void if_detach(struct ifnet *);
804 void if_down(struct ifnet *);
805 void if_link_state_change(struct ifnet *, int);
806 void if_slowtimo(void *);
807 void if_up(struct ifnet *);
808 int ifconf(u_long, caddr_t);
809 void ifinit(void);
810 int ifioctl(struct socket *, u_long, caddr_t, struct lwp *);
811 int ifpromisc(struct ifnet *, int);
812 struct ifnet *ifunit(const char *);
813
814 struct ifaddr *ifa_ifwithaddr(const struct sockaddr *);
815 struct ifaddr *ifa_ifwithaf(int);
816 struct ifaddr *ifa_ifwithdstaddr(const struct sockaddr *);
817 struct ifaddr *ifa_ifwithnet(const struct sockaddr *);
818 struct ifaddr *ifa_ifwithladdr(const struct sockaddr *);
819 struct ifaddr *ifa_ifwithroute(int, const struct sockaddr *,
820 const struct sockaddr *);
821 struct ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *);
822 void ifafree(struct ifaddr *);
823 void link_rtrequest(int, struct rtentry *, struct rt_addrinfo *);
824
825 void if_clone_attach(struct if_clone *);
826 void if_clone_detach(struct if_clone *);
827
828 int if_clone_create(const char *);
829 int if_clone_destroy(const char *);
830
831 int ifq_enqueue(struct ifnet *, struct mbuf * ALTQ_COMMA
832 ALTQ_DECL(struct altq_pktattr *));
833 int ifq_enqueue2(struct ifnet *, struct ifqueue *, struct mbuf * ALTQ_COMMA
834 ALTQ_DECL(struct altq_pktattr *));
835
836 int loioctl(struct ifnet *, u_long, caddr_t);
837 void loopattach(int);
838 int looutput(struct ifnet *,
839 struct mbuf *, struct sockaddr *, struct rtentry *);
840 void lortrequest(int, struct rtentry *, struct rt_addrinfo *);
841
842 /*
843 * These are exported because they're an easy way to tell if
844 * an interface is going away without having to burn a flag.
845 */
846 int if_nulloutput(struct ifnet *, struct mbuf *,
847 struct sockaddr *, struct rtentry *);
848 void if_nullinput(struct ifnet *, struct mbuf *);
849 void if_nullstart(struct ifnet *);
850 int if_nullioctl(struct ifnet *, u_long, caddr_t);
851 int if_nullinit(struct ifnet *);
852 void if_nullstop(struct ifnet *, int);
853 void if_nullwatchdog(struct ifnet *);
854 void if_nulldrain(struct ifnet *);
855 #else
856 struct if_nameindex {
857 unsigned int if_index; /* 1, 2, ... */
858 char *if_name; /* null terminated name: "le0", ... */
859 };
860
861 #include <sys/cdefs.h>
862 __BEGIN_DECLS
863 unsigned int if_nametoindex(const char *);
864 char * if_indextoname(unsigned int, char *);
865 struct if_nameindex * if_nameindex(void);
866 void if_freenameindex(struct if_nameindex *);
867 __END_DECLS
868 #endif /* _KERNEL */ /* XXX really ALTQ? */
869
870 #ifdef _KERNEL
871 /*
872 * ifq sysctl support
873 */
874 int sysctl_ifq(int *name, u_int namelen, void *oldp,
875 size_t *oldlenp, void *newp, size_t newlen,
876 struct ifqueue *ifq);
877 /* symbolic names for terminal (per-protocol) CTL_IFQ_ nodes */
878 #define IFQCTL_LEN 1
879 #define IFQCTL_MAXLEN 2
880 #define IFQCTL_PEAK 3
881 #define IFQCTL_DROPS 4
882 #define IFQCTL_MAXID 5
883
884 #endif /* _KERNEL */
885
886 #ifdef _NETBSD_SOURCE
887 /*
888 * sysctl for ifq (per-protocol packet input queue variant of ifqueue)
889 */
890 #define CTL_IFQ_NAMES { \
891 { 0, 0 }, \
892 { "len", CTLTYPE_INT }, \
893 { "maxlen", CTLTYPE_INT }, \
894 { "peak", CTLTYPE_INT }, \
895 { "drops", CTLTYPE_INT }, \
896 }
897 #endif /* _NETBSD_SOURCE */
898 #endif /* !_NET_IF_H_ */
899