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