1 /* $NetBSD: if.h,v 1.150 2011/02/01 01:39:20 matt 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 #include <sys/time.h> 116 117 #if defined(_KERNEL_OPT) 118 #include "opt_compat_netbsd.h" 119 #endif 120 121 struct mbuf; 122 struct proc; 123 struct rtentry; 124 struct socket; 125 struct ether_header; 126 struct ifaddr; 127 struct ifnet; 128 struct rt_addrinfo; 129 130 #define IFNAMSIZ IF_NAMESIZE 131 132 /* 133 * Structure describing a `cloning' interface. 134 */ 135 struct if_clone { 136 LIST_ENTRY(if_clone) ifc_list; /* on list of cloners */ 137 const char *ifc_name; /* name of device, e.g. `gif' */ 138 size_t ifc_namelen; /* length of name */ 139 140 int (*ifc_create)(struct if_clone *, int); 141 int (*ifc_destroy)(struct ifnet *); 142 }; 143 144 #define IF_CLONE_INITIALIZER(name, create, destroy) \ 145 { { NULL, NULL }, name, sizeof(name) - 1, create, destroy } 146 147 /* 148 * Structure used to query names of interface cloners. 149 */ 150 struct if_clonereq { 151 int ifcr_total; /* total cloners (out) */ 152 int ifcr_count; /* room for this many in user buffer */ 153 char *ifcr_buffer; /* buffer for cloner names */ 154 }; 155 156 /* 157 * Structure defining statistics and other data kept regarding a network 158 * interface. 159 */ 160 struct if_data { 161 /* generic interface information */ 162 u_char ifi_type; /* ethernet, tokenring, etc. */ 163 u_char ifi_addrlen; /* media address length */ 164 u_char ifi_hdrlen; /* media header length */ 165 int ifi_link_state; /* current link state */ 166 uint64_t ifi_mtu; /* maximum transmission unit */ 167 uint64_t ifi_metric; /* routing metric (external only) */ 168 uint64_t ifi_baudrate; /* linespeed */ 169 /* volatile statistics */ 170 uint64_t ifi_ipackets; /* packets received on interface */ 171 uint64_t ifi_ierrors; /* input errors on interface */ 172 uint64_t ifi_opackets; /* packets sent on interface */ 173 uint64_t ifi_oerrors; /* output errors on interface */ 174 uint64_t ifi_collisions; /* collisions on csma interfaces */ 175 uint64_t ifi_ibytes; /* total number of octets received */ 176 uint64_t ifi_obytes; /* total number of octets sent */ 177 uint64_t ifi_imcasts; /* packets received via multicast */ 178 uint64_t ifi_omcasts; /* packets sent via multicast */ 179 uint64_t ifi_iqdrops; /* dropped on input, this interface */ 180 uint64_t ifi_noproto; /* destined for unsupported protocol */ 181 struct timespec ifi_lastchange;/* last operational state change */ 182 }; 183 184 /* 185 * Values for if_link_state. 186 */ 187 #define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */ 188 #define LINK_STATE_DOWN 1 /* link is down */ 189 #define LINK_STATE_UP 2 /* link is up */ 190 191 /* 192 * Structure defining a queue for a network interface. 193 */ 194 struct ifqueue { 195 struct mbuf *ifq_head; 196 struct mbuf *ifq_tail; 197 int ifq_len; 198 int ifq_maxlen; 199 int ifq_drops; 200 }; 201 202 /* 203 * Structure defining a queue for a network interface. 204 * 205 * (Would like to call this struct ``if'', but C isn't PL/1.) 206 */ 207 TAILQ_HEAD(ifnet_head, ifnet); /* the actual queue head */ 208 209 typedef struct ifnet { 210 void *if_softc; /* lower-level data for this if */ 211 TAILQ_ENTRY(ifnet) if_list; /* all struct ifnets are chained */ 212 TAILQ_HEAD(, ifaddr) if_addrlist; /* linked list of addresses per if */ 213 char if_xname[IFNAMSIZ]; /* external name (name + unit) */ 214 int if_pcount; /* number of promiscuous listeners */ 215 struct bpf_if *if_bpf; /* packet filter structure */ 216 u_short if_index; /* numeric abbreviation for this if */ 217 short if_timer; /* time 'til if_watchdog called */ 218 short if_flags; /* up/down, broadcast, etc. */ 219 short if__pad1; /* be nice to m68k ports */ 220 struct if_data if_data; /* statistics and other data about if */ 221 /* 222 * Procedure handles. If you add more of these, don't forget the 223 * corresponding NULL stub in if.c. 224 */ 225 int (*if_output) /* output routine (enqueue) */ 226 (struct ifnet *, struct mbuf *, const struct sockaddr *, 227 struct rtentry *); 228 void (*if_input) /* input routine (from h/w driver) */ 229 (struct ifnet *, struct mbuf *); 230 void (*if_start) /* initiate output routine */ 231 (struct ifnet *); 232 int (*if_ioctl) /* ioctl routine */ 233 (struct ifnet *, u_long, void *); 234 int (*if_init) /* init routine */ 235 (struct ifnet *); 236 void (*if_stop) /* stop routine */ 237 (struct ifnet *, int); 238 void (*if_watchdog) /* timer routine */ 239 (struct ifnet *); 240 void (*if_drain) /* routine to release resources */ 241 (struct ifnet *); 242 struct ifaltq if_snd; /* output queue (includes altq) */ 243 struct ifaddr *if_dl; /* identity of this interface. */ 244 const struct sockaddr_dl *if_sadl; /* pointer to sockaddr_dl 245 * of if_dl 246 */ 247 /* if_hwdl: h/w identity 248 * 249 * May be NULL. If not NULL, it is the address assigned 250 * to the interface by the manufacturer, so it very likely 251 * to be unique. It MUST NOT be deleted. It is highly 252 * suitable for deriving the EUI64 for the interface. 253 */ 254 struct ifaddr *if_hwdl; 255 const uint8_t *if_broadcastaddr;/* linklevel broadcast bytestring */ 256 void *if_bridge; /* bridge glue */ 257 int if_dlt; /* data link type (<net/dlt.h>) */ 258 struct pfil_head if_pfil; /* filtering point */ 259 uint64_t if_capabilities; /* interface capabilities */ 260 uint64_t if_capenable; /* capabilities enabled */ 261 union { 262 void * carp_s; /* carp structure (used by !carp ifs) */ 263 struct ifnet *carp_d;/* ptr to carpdev (used by carp ifs) */ 264 } if_carp_ptr; 265 #define if_carp if_carp_ptr.carp_s 266 #define if_carpdev if_carp_ptr.carp_d 267 /* 268 * These are pre-computed based on an interfaces enabled 269 * capabilities, for speed elsewhere. 270 */ 271 int if_csum_flags_tx; /* M_CSUM_* flags for Tx */ 272 int if_csum_flags_rx; /* M_CSUM_* flags for Rx */ 273 274 void *if_afdata[AF_MAX]; 275 struct mowner *if_mowner; /* who owns mbufs for this interface */ 276 277 void *if_agrprivate; /* used only when #if NAGR > 0 */ 278 279 /* 280 * pf specific data, used only when #if NPF > 0. 281 */ 282 void *if_pf_kif; /* pf interface abstraction */ 283 void *if_pf_groups; /* pf interface groups */ 284 /* 285 * During an ifnet's lifetime, it has only one if_index, but 286 * and if_index is not sufficient to identify an ifnet 287 * because during the lifetime of the system, many ifnets may occupy a 288 * given if_index. Let us tell different ifnets at the same 289 * if_index apart by their if_index_gen, a unique number that each ifnet 290 * is assigned when it if_attach()s. Now, the kernel can use the 291 * pair (if_index, if_index_gen) as a weak reference to an ifnet. 292 */ 293 uint64_t if_index_gen; /* generation number for the ifnet 294 * at if_index: if two ifnets' index 295 * and generation number are both the 296 * same, they are the same ifnet. 297 */ 298 struct sysctllog *if_sysctl_log; 299 } ifnet_t; 300 301 #define if_mtu if_data.ifi_mtu 302 #define if_type if_data.ifi_type 303 #define if_addrlen if_data.ifi_addrlen 304 #define if_hdrlen if_data.ifi_hdrlen 305 #define if_metric if_data.ifi_metric 306 #define if_link_state if_data.ifi_link_state 307 #define if_baudrate if_data.ifi_baudrate 308 #define if_ipackets if_data.ifi_ipackets 309 #define if_ierrors if_data.ifi_ierrors 310 #define if_opackets if_data.ifi_opackets 311 #define if_oerrors if_data.ifi_oerrors 312 #define if_collisions if_data.ifi_collisions 313 #define if_ibytes if_data.ifi_ibytes 314 #define if_obytes if_data.ifi_obytes 315 #define if_imcasts if_data.ifi_imcasts 316 #define if_omcasts if_data.ifi_omcasts 317 #define if_iqdrops if_data.ifi_iqdrops 318 #define if_noproto if_data.ifi_noproto 319 #define if_lastchange if_data.ifi_lastchange 320 321 #define IFF_UP 0x0001 /* interface is up */ 322 #define IFF_BROADCAST 0x0002 /* broadcast address valid */ 323 #define IFF_DEBUG 0x0004 /* turn on debugging */ 324 #define IFF_LOOPBACK 0x0008 /* is a loopback net */ 325 #define IFF_POINTOPOINT 0x0010 /* interface is point-to-point link */ 326 #define IFF_NOTRAILERS 0x0020 /* avoid use of trailers */ 327 #define IFF_RUNNING 0x0040 /* resources allocated */ 328 #define IFF_NOARP 0x0080 /* no address resolution protocol */ 329 #define IFF_PROMISC 0x0100 /* receive all packets */ 330 #define IFF_ALLMULTI 0x0200 /* receive all multicast packets */ 331 #define IFF_OACTIVE 0x0400 /* transmission in progress */ 332 #define IFF_SIMPLEX 0x0800 /* can't hear own transmissions */ 333 #define IFF_LINK0 0x1000 /* per link layer defined bit */ 334 #define IFF_LINK1 0x2000 /* per link layer defined bit */ 335 #define IFF_LINK2 0x4000 /* per link layer defined bit */ 336 #define IFF_MULTICAST 0x8000 /* supports multicast */ 337 338 #define IFFBITS \ 339 "\020\1UP\2BROADCAST\3DEBUG\4LOOPBACK\5POINTOPOINT\6NOTRAILERS" \ 340 "\7RUNNING\10NOARP\11PROMISC\12ALLMULTI\13OACTIVE\14SIMPLEX" \ 341 "\15LINK0\16LINK1\17LINK2\20MULTICAST" 342 343 /* flags set internally only: */ 344 #define IFF_CANTCHANGE \ 345 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 346 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_PROMISC) 347 348 /* 349 * Some convenience macros used for setting ifi_baudrate. 350 * XXX 1000 vs. 1024? --thorpej@NetBSD.org 351 */ 352 #define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */ 353 #define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */ 354 #define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */ 355 356 /* Capabilities that interfaces can advertise. */ 357 #define IFCAP_TSOv4 0x00080 /* can do TCPv4 segmentation offload */ 358 #define IFCAP_CSUM_IPv4_Rx 0x00100 /* can do IPv4 header checksums (Rx) */ 359 #define IFCAP_CSUM_IPv4_Tx 0x00200 /* can do IPv4 header checksums (Tx) */ 360 #define IFCAP_CSUM_TCPv4_Rx 0x00400 /* can do IPv4/TCP checksums (Rx) */ 361 #define IFCAP_CSUM_TCPv4_Tx 0x00800 /* can do IPv4/TCP checksums (Tx) */ 362 #define IFCAP_CSUM_UDPv4_Rx 0x01000 /* can do IPv4/UDP checksums (Rx) */ 363 #define IFCAP_CSUM_UDPv4_Tx 0x02000 /* can do IPv4/UDP checksums (Tx) */ 364 #define IFCAP_CSUM_TCPv6_Rx 0x04000 /* can do IPv6/TCP checksums (Rx) */ 365 #define IFCAP_CSUM_TCPv6_Tx 0x08000 /* can do IPv6/TCP checksums (Tx) */ 366 #define IFCAP_CSUM_UDPv6_Rx 0x10000 /* can do IPv6/UDP checksums (Rx) */ 367 #define IFCAP_CSUM_UDPv6_Tx 0x20000 /* can do IPv6/UDP checksums (Tx) */ 368 #define IFCAP_TSOv6 0x40000 /* can do TCPv6 segmentation offload */ 369 370 #define IFCAPBITS \ 371 "\020" \ 372 "\10TSO4" \ 373 "\11IP4CSUM_Rx" \ 374 "\12IP4CSUM_Tx" \ 375 "\13TCP4CSUM_Rx" \ 376 "\14TCP4CSUM_Tx" \ 377 "\15UDP4CSUM_Rx" \ 378 "\16UDP4CSUM_Tx" \ 379 "\17TCP6CSUM_Rx" \ 380 "\20TCP6CSUM_Tx" \ 381 "\21UDP6CSUM_Rx" \ 382 "\22UDP6CSUM_Tx" \ 383 "\23TSO6" 384 385 /* 386 * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1) 387 * input routines have queues of messages stored on ifqueue structures 388 * (defined above). Entries are added to and deleted from these structures 389 * by these macros, which should be called with ipl raised to splnet(). 390 */ 391 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 392 #define IF_DROP(ifq) ((ifq)->ifq_drops++) 393 #define IF_ENQUEUE(ifq, m) do { \ 394 (m)->m_nextpkt = 0; \ 395 if ((ifq)->ifq_tail == 0) \ 396 (ifq)->ifq_head = m; \ 397 else \ 398 (ifq)->ifq_tail->m_nextpkt = m; \ 399 (ifq)->ifq_tail = m; \ 400 (ifq)->ifq_len++; \ 401 } while (/*CONSTCOND*/0) 402 #define IF_PREPEND(ifq, m) do { \ 403 (m)->m_nextpkt = (ifq)->ifq_head; \ 404 if ((ifq)->ifq_tail == 0) \ 405 (ifq)->ifq_tail = (m); \ 406 (ifq)->ifq_head = (m); \ 407 (ifq)->ifq_len++; \ 408 } while (/*CONSTCOND*/0) 409 #define IF_DEQUEUE(ifq, m) do { \ 410 (m) = (ifq)->ifq_head; \ 411 if (m) { \ 412 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \ 413 (ifq)->ifq_tail = 0; \ 414 (m)->m_nextpkt = 0; \ 415 (ifq)->ifq_len--; \ 416 } \ 417 } while (/*CONSTCOND*/0) 418 #define IF_POLL(ifq, m) ((m) = (ifq)->ifq_head) 419 #define IF_PURGE(ifq) \ 420 do { \ 421 struct mbuf *__m0; \ 422 \ 423 for (;;) { \ 424 IF_DEQUEUE((ifq), __m0); \ 425 if (__m0 == NULL) \ 426 break; \ 427 else \ 428 m_freem(__m0); \ 429 } \ 430 } while (/*CONSTCOND*/ 0) 431 #define IF_IS_EMPTY(ifq) ((ifq)->ifq_len == 0) 432 433 #ifndef IFQ_MAXLEN 434 #define IFQ_MAXLEN 256 435 #endif 436 #define IFNET_SLOWHZ 1 /* granularity is 1 second */ 437 438 /* 439 * Structure defining statistics and other data kept regarding an address 440 * on a network interface. 441 */ 442 struct ifaddr_data { 443 int64_t ifad_inbytes; 444 int64_t ifad_outbytes; 445 }; 446 447 /* 448 * The ifaddr structure contains information about one address 449 * of an interface. They are maintained by the different address families, 450 * are allocated and attached when an address is set, and are linked 451 * together so all addresses for an interface can be located. 452 */ 453 struct ifaddr { 454 struct sockaddr *ifa_addr; /* address of interface */ 455 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 456 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 457 struct sockaddr *ifa_netmask; /* used to determine subnet */ 458 struct ifnet *ifa_ifp; /* back-pointer to interface */ 459 TAILQ_ENTRY(ifaddr) ifa_list; /* list of addresses for interface */ 460 struct ifaddr_data ifa_data; /* statistics on the address */ 461 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 462 (int, struct rtentry *, const struct rt_addrinfo *); 463 u_int ifa_flags; /* mostly rt_flags for cloning */ 464 int ifa_refcnt; /* count of references */ 465 int ifa_metric; /* cost of going out this interface */ 466 struct ifaddr *(*ifa_getifa)(struct ifaddr *, 467 const struct sockaddr *); 468 uint32_t *ifa_seqno; 469 int16_t ifa_preference; /* preference level for this address */ 470 }; 471 #define IFA_ROUTE RTF_UP /* (0x01) route installed */ 472 473 /* 474 * Message format for use in obtaining information about interfaces from 475 * sysctl and the routing socket. We need to force 64-bit alignment if we 476 * aren't using compatiblity definitons. 477 */ 478 #if !defined(_KERNEL) || !defined(COMPAT_RTSOCK) 479 #define __align64 __aligned(sizeof(uint64_t)) 480 #else 481 #define __align64 482 #endif 483 struct if_msghdr { 484 u_short ifm_msglen __align64; 485 /* 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_data ifm_data __align64; 492 /* statistics and other data about if */ 493 }; 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 __align64; 501 /* to skip over non-understood messages */ 502 u_char ifam_version; /* future binary compatibility */ 503 u_char ifam_type; /* message type */ 504 int ifam_addrs; /* like rtm_addrs */ 505 int ifam_flags; /* value of ifa_flags */ 506 int ifam_metric; /* value of ifa_metric */ 507 u_short ifam_index; /* index for associated ifp */ 508 }; 509 510 /* 511 * Message format announcing the arrival or departure of a network interface. 512 */ 513 struct if_announcemsghdr { 514 u_short ifan_msglen __align64; 515 /* 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 #undef __align64 527 528 /* 529 * Interface request structure used for socket 530 * ioctl's. All interface ioctl's must have parameter 531 * definitions which begin with ifr_name. The 532 * remainder may be interface specific. 533 */ 534 struct ifreq { 535 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 536 union { 537 struct sockaddr ifru_addr; 538 struct sockaddr ifru_dstaddr; 539 struct sockaddr ifru_broadaddr; 540 struct sockaddr_storage ifru_space; 541 short ifru_flags; 542 int ifru_metric; 543 int ifru_mtu; 544 int ifru_dlt; 545 u_int ifru_value; 546 void * ifru_data; 547 struct { 548 uint32_t b_buflen; 549 void *b_buf; 550 } ifru_b; 551 } ifr_ifru; 552 #define ifr_addr ifr_ifru.ifru_addr /* address */ 553 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 554 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 555 #define ifr_space ifr_ifru.ifru_space /* sockaddr_storage */ 556 #define ifr_flags ifr_ifru.ifru_flags /* flags */ 557 #define ifr_metric ifr_ifru.ifru_metric /* metric */ 558 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 559 #define ifr_dlt ifr_ifru.ifru_dlt /* data link type (DLT_*) */ 560 #define ifr_value ifr_ifru.ifru_value /* generic value */ 561 #define ifr_media ifr_ifru.ifru_metric /* media options (overload) */ 562 #define ifr_data ifr_ifru.ifru_data /* for use by interface 563 * XXX deprecated 564 */ 565 #define ifr_buf ifr_ifru.ifru_b.b_buf /* new interface ioctls */ 566 #define ifr_buflen ifr_ifru.ifru_b.b_buflen 567 }; 568 569 #ifdef _KERNEL 570 #define ifreq_setdstaddr ifreq_setaddr 571 #define ifreq_setbroadaddr ifreq_setaddr 572 #define ifreq_getdstaddr ifreq_getaddr 573 #define ifreq_getbroadaddr ifreq_getaddr 574 575 static inline const struct sockaddr * 576 ifreq_getaddr(u_long cmd, const struct ifreq *ifr) 577 { 578 return &ifr->ifr_addr; 579 } 580 #endif /* _KERNEL */ 581 582 struct ifcapreq { 583 char ifcr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 584 uint64_t ifcr_capabilities; /* supported capabiliites */ 585 uint64_t ifcr_capenable; /* capabilities enabled */ 586 }; 587 588 struct ifaliasreq { 589 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 590 struct sockaddr ifra_addr; 591 struct sockaddr ifra_dstaddr; 592 #define ifra_broadaddr ifra_dstaddr 593 struct sockaddr ifra_mask; 594 }; 595 596 struct ifdatareq { 597 char ifdr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 598 struct if_data ifdr_data; 599 }; 600 601 struct ifmediareq { 602 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 603 int ifm_current; /* current media options */ 604 int ifm_mask; /* don't care mask */ 605 int ifm_status; /* media status */ 606 int ifm_active; /* active options */ 607 int ifm_count; /* # entries in ifm_ulist 608 array */ 609 int *ifm_ulist; /* media words */ 610 }; 611 612 613 struct ifdrv { 614 char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 615 unsigned long ifd_cmd; 616 size_t ifd_len; 617 void *ifd_data; 618 }; 619 #define IFLINKSTR_QUERYLEN 0x01 620 #define IFLINKSTR_UNSET 0x02 621 622 /* 623 * Structure used in SIOCGIFCONF request. 624 * Used to retrieve interface configuration 625 * for machine (useful for programs which 626 * must know all networks accessible). 627 */ 628 struct ifconf { 629 int ifc_len; /* size of associated buffer */ 630 union { 631 void * ifcu_buf; 632 struct ifreq *ifcu_req; 633 } ifc_ifcu; 634 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 635 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 636 }; 637 638 /* 639 * Structure for SIOC[AGD]LIFADDR 640 */ 641 struct if_laddrreq { 642 char iflr_name[IFNAMSIZ]; 643 unsigned int flags; 644 #define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ 645 #define IFLR_ACTIVE 0x4000 /* in/out: link-layer address activation */ 646 #define IFLR_FACTORY 0x2000 /* in/out: factory link-layer address */ 647 unsigned int prefixlen; /* in/out */ 648 struct sockaddr_storage addr; /* in/out */ 649 struct sockaddr_storage dstaddr; /* out */ 650 }; 651 652 /* 653 * Structure for SIOC[SG]IFADDRPREF 654 */ 655 struct if_addrprefreq { 656 char ifap_name[IFNAMSIZ]; 657 int16_t ifap_preference; /* in/out */ 658 struct sockaddr_storage ifap_addr; /* in/out */ 659 }; 660 661 #include <net/if_arp.h> 662 663 #endif /* _NETBSD_SOURCE */ 664 665 #ifdef _KERNEL 666 #ifdef IFAREF_DEBUG 667 #define IFAREF(ifa) \ 668 do { \ 669 printf("IFAREF: %s:%d %p -> %d\n", __FILE__, __LINE__, \ 670 (ifa), ++(ifa)->ifa_refcnt); \ 671 } while (/*CONSTCOND*/ 0) 672 673 #define IFAFREE(ifa) \ 674 do { \ 675 if ((ifa)->ifa_refcnt <= 0) \ 676 panic("%s:%d: %p ifa_refcnt <= 0", __FILE__, \ 677 __LINE__, (ifa)); \ 678 printf("IFAFREE: %s:%d %p -> %d\n", __FILE__, __LINE__, \ 679 (ifa), --(ifa)->ifa_refcnt); \ 680 if ((ifa)->ifa_refcnt == 0) \ 681 ifafree(ifa); \ 682 } while (/*CONSTCOND*/ 0) 683 #else 684 #define IFAREF(ifa) (ifa)->ifa_refcnt++ 685 686 #ifdef DIAGNOSTIC 687 #define IFAFREE(ifa) \ 688 do { \ 689 if ((ifa)->ifa_refcnt <= 0) \ 690 panic("%s:%d: %p ifa_refcnt <= 0", __FILE__, \ 691 __LINE__, (ifa)); \ 692 if (--(ifa)->ifa_refcnt == 0) \ 693 ifafree(ifa); \ 694 } while (/*CONSTCOND*/ 0) 695 #else 696 #define IFAFREE(ifa) \ 697 do { \ 698 if (--(ifa)->ifa_refcnt == 0) \ 699 ifafree(ifa); \ 700 } while (/*CONSTCOND*/ 0) 701 #endif /* DIAGNOSTIC */ 702 #endif /* IFAREF_DEBUG */ 703 704 #ifdef ALTQ 705 #define ALTQ_DECL(x) x 706 #define ALTQ_COMMA , 707 708 #define IFQ_ENQUEUE(ifq, m, pattr, err) \ 709 do { \ 710 if (ALTQ_IS_ENABLED((ifq))) \ 711 ALTQ_ENQUEUE((ifq), (m), (pattr), (err)); \ 712 else { \ 713 if (IF_QFULL((ifq))) { \ 714 m_freem((m)); \ 715 (err) = ENOBUFS; \ 716 } else { \ 717 IF_ENQUEUE((ifq), (m)); \ 718 (err) = 0; \ 719 } \ 720 } \ 721 if ((err)) \ 722 (ifq)->ifq_drops++; \ 723 } while (/*CONSTCOND*/ 0) 724 725 #define IFQ_DEQUEUE(ifq, m) \ 726 do { \ 727 if (TBR_IS_ENABLED((ifq))) \ 728 (m) = tbr_dequeue((ifq), ALTDQ_REMOVE); \ 729 else if (ALTQ_IS_ENABLED((ifq))) \ 730 ALTQ_DEQUEUE((ifq), (m)); \ 731 else \ 732 IF_DEQUEUE((ifq), (m)); \ 733 } while (/*CONSTCOND*/ 0) 734 735 #define IFQ_POLL(ifq, m) \ 736 do { \ 737 if (TBR_IS_ENABLED((ifq))) \ 738 (m) = tbr_dequeue((ifq), ALTDQ_POLL); \ 739 else if (ALTQ_IS_ENABLED((ifq))) \ 740 ALTQ_POLL((ifq), (m)); \ 741 else \ 742 IF_POLL((ifq), (m)); \ 743 } while (/*CONSTCOND*/ 0) 744 745 #define IFQ_PURGE(ifq) \ 746 do { \ 747 if (ALTQ_IS_ENABLED((ifq))) \ 748 ALTQ_PURGE((ifq)); \ 749 else \ 750 IF_PURGE((ifq)); \ 751 } while (/*CONSTCOND*/ 0) 752 753 #define IFQ_SET_READY(ifq) \ 754 do { \ 755 (ifq)->altq_flags |= ALTQF_READY; \ 756 } while (/*CONSTCOND*/ 0) 757 758 #define IFQ_CLASSIFY(ifq, m, af, pattr) \ 759 do { \ 760 if (ALTQ_IS_ENABLED((ifq))) { \ 761 if (ALTQ_NEEDS_CLASSIFY((ifq))) \ 762 (pattr)->pattr_class = (*(ifq)->altq_classify) \ 763 ((ifq)->altq_clfier, (m), (af)); \ 764 (pattr)->pattr_af = (af); \ 765 (pattr)->pattr_hdr = mtod((m), void *); \ 766 } \ 767 } while (/*CONSTCOND*/ 0) 768 #else /* ! ALTQ */ 769 #define ALTQ_DECL(x) /* nothing */ 770 #define ALTQ_COMMA 771 772 #define IFQ_ENQUEUE(ifq, m, pattr, err) \ 773 do { \ 774 if (IF_QFULL((ifq))) { \ 775 m_freem((m)); \ 776 (err) = ENOBUFS; \ 777 } else { \ 778 IF_ENQUEUE((ifq), (m)); \ 779 (err) = 0; \ 780 } \ 781 if ((err)) \ 782 (ifq)->ifq_drops++; \ 783 } while (/*CONSTCOND*/ 0) 784 785 #define IFQ_DEQUEUE(ifq, m) IF_DEQUEUE((ifq), (m)) 786 787 #define IFQ_POLL(ifq, m) IF_POLL((ifq), (m)) 788 789 #define IFQ_PURGE(ifq) IF_PURGE((ifq)) 790 791 #define IFQ_SET_READY(ifq) /* nothing */ 792 793 #define IFQ_CLASSIFY(ifq, m, af, pattr) /* nothing */ 794 795 #endif /* ALTQ */ 796 797 #define IFQ_IS_EMPTY(ifq) IF_IS_EMPTY((ifq)) 798 #define IFQ_INC_LEN(ifq) ((ifq)->ifq_len++) 799 #define IFQ_DEC_LEN(ifq) (--(ifq)->ifq_len) 800 #define IFQ_INC_DROPS(ifq) ((ifq)->ifq_drops++) 801 #define IFQ_SET_MAXLEN(ifq, len) ((ifq)->ifq_maxlen = (len)) 802 803 #include <sys/mallocvar.h> 804 MALLOC_DECLARE(M_IFADDR); 805 MALLOC_DECLARE(M_IFMADDR); 806 807 #define IFNET_FIRST() TAILQ_FIRST(&ifnet) 808 #define IFNET_NEXT(__ifp) TAILQ_NEXT((__ifp), if_list) 809 #define IFNET_FOREACH(__ifp) TAILQ_FOREACH(__ifp, &ifnet, if_list) 810 #define IFADDR_FIRST(__ifp) TAILQ_FIRST(&(__ifp)->if_addrlist) 811 #define IFADDR_NEXT(__ifa) TAILQ_NEXT((__ifa), ifa_list) 812 #define IFADDR_FOREACH(__ifa, __ifp) TAILQ_FOREACH(__ifa, \ 813 &(__ifp)->if_addrlist, ifa_list) 814 #define IFADDR_EMPTY(__ifp) TAILQ_EMPTY(&(__ifp)->if_addrlist) 815 816 extern struct ifnet_head ifnet; 817 extern struct ifnet **ifindex2ifnet; 818 extern struct ifnet *lo0ifp; 819 extern size_t if_indexlim; 820 821 void ether_input(struct ifnet *, struct mbuf *); 822 823 int ifreq_setaddr(u_long, struct ifreq *, const struct sockaddr *); 824 825 struct ifnet *if_alloc(u_char); 826 void if_initname(struct ifnet *, const char *, int); 827 struct ifaddr *if_dl_create(const struct ifnet *, const struct sockaddr_dl **); 828 void if_activate_sadl(struct ifnet *, struct ifaddr *, 829 const struct sockaddr_dl *); 830 void if_set_sadl(struct ifnet *, const void *, u_char, bool); 831 void if_alloc_sadl(struct ifnet *); 832 void if_free_sadl(struct ifnet *); 833 void if_attach(struct ifnet *); 834 void if_attachdomain(void); 835 void if_attachdomain1(struct ifnet *); 836 void if_deactivate(struct ifnet *); 837 void if_purgeaddrs(struct ifnet *, int, void (*)(struct ifaddr *)); 838 void if_detach(struct ifnet *); 839 void if_down(struct ifnet *); 840 void if_link_state_change(struct ifnet *, int); 841 void if_slowtimo(void *); 842 void if_up(struct ifnet *); 843 int ifconf(u_long, void *); 844 void ifinit(void); 845 void ifinit1(void); 846 int ifaddrpref_ioctl(struct socket *, u_long, void *, struct ifnet *, 847 lwp_t *); 848 int ifioctl(struct socket *, u_long, void *, struct lwp *); 849 int ifioctl_common(struct ifnet *, u_long, void *); 850 int ifpromisc(struct ifnet *, int); 851 struct ifnet *ifunit(const char *); 852 853 void ifa_insert(struct ifnet *, struct ifaddr *); 854 void ifa_remove(struct ifnet *, struct ifaddr *); 855 856 struct ifaddr *ifa_ifwithaddr(const struct sockaddr *); 857 struct ifaddr *ifa_ifwithaf(int); 858 struct ifaddr *ifa_ifwithdstaddr(const struct sockaddr *); 859 struct ifaddr *ifa_ifwithnet(const struct sockaddr *); 860 struct ifaddr *ifa_ifwithladdr(const struct sockaddr *); 861 struct ifaddr *ifa_ifwithroute(int, const struct sockaddr *, 862 const struct sockaddr *); 863 struct ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *); 864 void ifafree(struct ifaddr *); 865 void link_rtrequest(int, struct rtentry *, const struct rt_addrinfo *); 866 867 void if_clone_attach(struct if_clone *); 868 void if_clone_detach(struct if_clone *); 869 870 int if_clone_create(const char *); 871 int if_clone_destroy(const char *); 872 873 int ifq_enqueue(struct ifnet *, struct mbuf * ALTQ_COMMA 874 ALTQ_DECL(struct altq_pktattr *)); 875 int ifq_enqueue2(struct ifnet *, struct ifqueue *, struct mbuf * ALTQ_COMMA 876 ALTQ_DECL(struct altq_pktattr *)); 877 878 int loioctl(struct ifnet *, u_long, void *); 879 void loopattach(int); 880 int looutput(struct ifnet *, 881 struct mbuf *, const struct sockaddr *, struct rtentry *); 882 void lortrequest(int, struct rtentry *, const struct rt_addrinfo *); 883 884 /* 885 * These are exported because they're an easy way to tell if 886 * an interface is going away without having to burn a flag. 887 */ 888 int if_nulloutput(struct ifnet *, struct mbuf *, 889 const struct sockaddr *, struct rtentry *); 890 void if_nullinput(struct ifnet *, struct mbuf *); 891 void if_nullstart(struct ifnet *); 892 int if_nullioctl(struct ifnet *, u_long, void *); 893 int if_nullinit(struct ifnet *); 894 void if_nullstop(struct ifnet *, int); 895 void if_nullwatchdog(struct ifnet *); 896 void if_nulldrain(struct ifnet *); 897 #else 898 struct if_nameindex { 899 unsigned int if_index; /* 1, 2, ... */ 900 char *if_name; /* null terminated name: "le0", ... */ 901 }; 902 903 #include <sys/cdefs.h> 904 __BEGIN_DECLS 905 unsigned int if_nametoindex(const char *); 906 char * if_indextoname(unsigned int, char *); 907 struct if_nameindex * if_nameindex(void); 908 void if_freenameindex(struct if_nameindex *); 909 __END_DECLS 910 #endif /* _KERNEL */ /* XXX really ALTQ? */ 911 912 #ifdef _KERNEL 913 914 ifnet_t * if_byindex(u_int); 915 916 /* 917 * ifq sysctl support 918 */ 919 int sysctl_ifq(int *name, u_int namelen, void *oldp, 920 size_t *oldlenp, void *newp, size_t newlen, 921 struct ifqueue *ifq); 922 /* symbolic names for terminal (per-protocol) CTL_IFQ_ nodes */ 923 #define IFQCTL_LEN 1 924 #define IFQCTL_MAXLEN 2 925 #define IFQCTL_PEAK 3 926 #define IFQCTL_DROPS 4 927 #define IFQCTL_MAXID 5 928 929 #endif /* _KERNEL */ 930 931 #ifdef _NETBSD_SOURCE 932 /* 933 * sysctl for ifq (per-protocol packet input queue variant of ifqueue) 934 */ 935 #define CTL_IFQ_NAMES { \ 936 { 0, 0 }, \ 937 { "len", CTLTYPE_INT }, \ 938 { "maxlen", CTLTYPE_INT }, \ 939 { "peak", CTLTYPE_INT }, \ 940 { "drops", CTLTYPE_INT }, \ 941 } 942 #endif /* _NETBSD_SOURCE */ 943 #endif /* !_NET_IF_H_ */ 944