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