if.h revision 1.294
1 /* $NetBSD: if.h,v 1.294 2021/09/30 03:23:48 yamaguchi 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 /* 79 * Length of interface description, including terminating '\0'. 80 */ 81 #define IFDESCRSIZE 64 82 83 #if defined(_NETBSD_SOURCE) 84 85 #include <sys/socket.h> 86 #include <sys/queue.h> 87 #include <sys/mutex.h> 88 #include <sys/hook.h> 89 90 #include <net/dlt.h> 91 #include <net/pfil.h> 92 #ifdef _KERNEL 93 #include <net/pktqueue.h> 94 #include <sys/pslist.h> 95 #include <sys/pserialize.h> 96 #include <sys/psref.h> 97 #include <sys/module_hook.h> 98 #endif 99 100 /* 101 * Always include ALTQ glue here -- we use the ALTQ interface queue 102 * structure even when ALTQ is not configured into the kernel so that 103 * the size of struct ifnet does not changed based on the option. The 104 * ALTQ queue structure is API-compatible with the legacy ifqueue. 105 */ 106 #include <altq/if_altq.h> 107 108 /* 109 * Structures defining a network interface, providing a packet 110 * transport mechanism (ala level 0 of the PUP protocols). 111 * 112 * Each interface accepts output datagrams of a specified maximum 113 * length, and provides higher level routines with input datagrams 114 * received from its medium. 115 * 116 * Output occurs when the routine if_output is called, with four parameters: 117 * (*ifp->if_output)(ifp, m, dst, rt) 118 * Here m is the mbuf chain to be sent and dst is the destination address. 119 * The output routine encapsulates the supplied datagram if necessary, 120 * and then transmits it on its medium. 121 * 122 * On input, each interface unwraps the data received by it, and either 123 * places it on the input queue of a internetwork datagram routine 124 * and posts the associated software interrupt, or passes the datagram to a raw 125 * packet input routine. 126 * 127 * Routines exist for locating interfaces by their addresses 128 * or for locating a interface on a certain network, as well as more general 129 * routing and gateway routines maintaining information used to locate 130 * interfaces. These routines live in the files if.c and route.c 131 */ 132 #include <sys/time.h> 133 134 #if defined(_KERNEL_OPT) 135 #include "opt_compat_netbsd.h" 136 #include "opt_gateway.h" 137 #endif 138 139 struct mbuf; 140 struct proc; 141 struct rtentry; 142 struct socket; 143 struct ether_header; 144 struct ifaddr; 145 struct ifnet; 146 struct rt_addrinfo; 147 148 #define IFNAMSIZ IF_NAMESIZE 149 150 /* 151 * Structure describing a `cloning' interface. 152 */ 153 struct if_clone { 154 LIST_ENTRY(if_clone) ifc_list; /* on list of cloners */ 155 const char *ifc_name; /* name of device, e.g. `gif' */ 156 size_t ifc_namelen; /* length of name */ 157 158 int (*ifc_create)(struct if_clone *, int); 159 int (*ifc_destroy)(struct ifnet *); 160 }; 161 162 #define IF_CLONE_INITIALIZER(name, create, destroy) \ 163 { { NULL, NULL }, name, sizeof(name) - 1, create, destroy } 164 165 /* 166 * Structure used to query names of interface cloners. 167 */ 168 struct if_clonereq { 169 int ifcr_total; /* total cloners (out) */ 170 int ifcr_count; /* room for this many in user buffer */ 171 char *ifcr_buffer; /* buffer for cloner names */ 172 }; 173 174 /* 175 * Structure defining statistics and other data kept regarding a network 176 * interface. 177 * 178 * Only used for exporting data from the interface. 179 */ 180 struct if_data { 181 /* generic interface information */ 182 u_char ifi_type; /* ethernet, tokenring, etc. */ 183 u_char ifi_addrlen; /* media address length */ 184 u_char ifi_hdrlen; /* media header length */ 185 int ifi_link_state; /* current link state */ 186 uint64_t ifi_mtu; /* maximum transmission unit */ 187 uint64_t ifi_metric; /* routing metric (external only) */ 188 uint64_t ifi_baudrate; /* linespeed */ 189 /* volatile statistics */ 190 uint64_t ifi_ipackets; /* packets received on interface */ 191 uint64_t ifi_ierrors; /* input errors on interface */ 192 uint64_t ifi_opackets; /* packets sent on interface */ 193 uint64_t ifi_oerrors; /* output errors on interface */ 194 uint64_t ifi_collisions; /* collisions on csma interfaces */ 195 uint64_t ifi_ibytes; /* total number of octets received */ 196 uint64_t ifi_obytes; /* total number of octets sent */ 197 uint64_t ifi_imcasts; /* packets received via multicast */ 198 uint64_t ifi_omcasts; /* packets sent via multicast */ 199 uint64_t ifi_iqdrops; /* dropped on input, this interface */ 200 uint64_t ifi_noproto; /* destined for unsupported protocol */ 201 struct timespec ifi_lastchange;/* last operational state change */ 202 }; 203 204 /* 205 * Values for if_link_state. 206 */ 207 #define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */ 208 #define LINK_STATE_DOWN 1 /* link is down */ 209 #define LINK_STATE_UP 2 /* link is up */ 210 211 /* 212 * Status bit descriptions for the various interface types. 213 */ 214 struct if_status_description { 215 unsigned char ifs_type; 216 unsigned char ifs_state; 217 const char *ifs_string; 218 }; 219 220 #define LINK_STATE_DESC_MATCH(_ifs, _t, _s) \ 221 (((_ifs)->ifs_type == (_t) || (_ifs)->ifs_type == 0) && \ 222 (_ifs)->ifs_state == (_s)) 223 224 #define LINK_STATE_DESCRIPTIONS { \ 225 { IFT_ETHER, LINK_STATE_DOWN, "no carrier" }, \ 226 { IFT_IEEE80211, LINK_STATE_DOWN, "no network" }, \ 227 { IFT_PPP, LINK_STATE_DOWN, "no carrier" }, \ 228 { IFT_CARP, LINK_STATE_DOWN, "backup" }, \ 229 { IFT_CARP, LINK_STATE_UP, "master" }, \ 230 { 0, LINK_STATE_UP, "active" }, \ 231 { 0, LINK_STATE_UNKNOWN, "unknown" }, \ 232 { 0, LINK_STATE_DOWN, "down" }, \ 233 { 0, 0, NULL } \ 234 } 235 236 /* 237 * Structure defining a queue for a network interface. 238 */ 239 struct ifqueue { 240 struct mbuf *ifq_head; 241 struct mbuf *ifq_tail; 242 int ifq_len; 243 int ifq_maxlen; 244 int ifq_drops; 245 kmutex_t *ifq_lock; 246 }; 247 248 #ifdef _KERNEL 249 #include <sys/percpu.h> 250 #include <sys/callout.h> 251 #include <sys/rwlock.h> 252 #include <sys/workqueue.h> 253 254 #endif /* _KERNEL */ 255 256 /* 257 * Structure defining a queue for a network interface. 258 * 259 * (Would like to call this struct ``if'', but C isn't PL/1.) 260 */ 261 TAILQ_HEAD(ifnet_head, ifnet); /* the actual queue head */ 262 263 struct bridge_softc; 264 struct bridge_iflist; 265 struct callout; 266 struct krwlock; 267 struct if_percpuq; 268 struct if_deferred_start; 269 struct in6_multi; 270 271 typedef unsigned short if_index_t; 272 273 /* 274 * Interface. Field markings and the corresponding locks: 275 * 276 * i: IFNET_LOCK (a.k.a., if_ioctl_lock) 277 * q: ifq_lock (struct ifaltq) 278 * a: if_afdata_lock 279 * 6: in6_multilock (global lock) 280 * :: unlocked, stable 281 * ?: unknown, maybe unsafe 282 * 283 * Lock order: IFNET_LOCK => in6_multilock => if_afdata_lock => ifq_lock 284 * Note that currently if_afdata_lock and ifq_lock aren't held 285 * at the same time, but define the order anyway. 286 * 287 * Lock order of IFNET_LOCK with other locks: 288 * softnet_lock => solock => IFNET_LOCK => ND6_LOCK, in_multilock 289 */ 290 typedef struct ifnet { 291 void *if_softc; /* :: lower-level data for this if */ 292 /* DEPRECATED. Keep it to avoid breaking kvm(3) users */ 293 TAILQ_ENTRY(ifnet) 294 if_list; /* i: all struct ifnets are chained */ 295 TAILQ_HEAD(, ifaddr) 296 if_addrlist; /* i: linked list of addresses per if */ 297 char if_xname[IFNAMSIZ]; 298 /* :: external name (name + unit) */ 299 int if_pcount; /* i: number of promiscuous listeners */ 300 struct bpf_if *if_bpf; /* :: packet filter structure */ 301 if_index_t if_index; /* :: numeric abbreviation for this if */ 302 short if_timer; /* ?: time 'til if_slowtimo called */ 303 unsigned short if_flags; /* i: up/down, broadcast, etc. */ 304 short if_extflags; /* :: if_output MP-safe, etc. */ 305 u_char if_type; /* :: ethernet, tokenring, etc. */ 306 u_char if_addrlen; /* :: media address length */ 307 u_char if_hdrlen; /* :: media header length */ 308 /* XXX audit :? fields here. */ 309 int if_link_state; /* :? current link state */ 310 uint64_t if_mtu; /* :? maximum transmission unit */ 311 uint64_t if_metric; /* :? routing metric (external only) */ 312 uint64_t if_baudrate; /* :? linespeed */ 313 struct timespec if_lastchange; /* :? last operational state change */ 314 #ifdef _KERNEL 315 percpu_t *if_stats; /* :: statistics */ 316 #else 317 void *if_stats; /* opaque to user-space */ 318 #endif /* _KERNEL */ 319 /* 320 * Procedure handles. If you add more of these, don't forget the 321 * corresponding NULL stub in if.c. 322 */ 323 int (*if_output) /* :: output routine (enqueue) */ 324 (struct ifnet *, struct mbuf *, const struct sockaddr *, 325 const struct rtentry *); 326 void (*_if_input) /* :: input routine (from h/w driver) */ 327 (struct ifnet *, struct mbuf *); 328 void (*if_start) /* :: initiate output routine */ 329 (struct ifnet *); 330 int (*if_transmit) /* :: output routine, must be MP-safe */ 331 (struct ifnet *, struct mbuf *); 332 int (*if_ioctl) /* :: ioctl routine */ 333 (struct ifnet *, u_long, void *); 334 int (*if_init) /* :: init routine */ 335 (struct ifnet *); 336 void (*if_stop) /* :: stop routine */ 337 (struct ifnet *, int); 338 void (*if_slowtimo) /* :: timer routine */ 339 (struct ifnet *); 340 #define if_watchdog if_slowtimo 341 void (*if_drain) /* :: routine to release resources */ 342 (struct ifnet *); 343 struct ifaltq if_snd; /* q: output queue (includes altq) */ 344 struct ifaddr *if_dl; /* i: identity of this interface. */ 345 const struct sockaddr_dl 346 *if_sadl; /* i: pointer to sockaddr_dl of if_dl */ 347 /* 348 * May be NULL. If not NULL, it is the address assigned 349 * to the interface by the manufacturer, so it very likely 350 * to be unique. It MUST NOT be deleted. It is highly 351 * suitable for deriving the EUI64 for the interface. 352 */ 353 struct ifaddr *if_hwdl; /* i: h/w identity */ 354 const uint8_t *if_broadcastaddr; 355 /* :: linklevel broadcast bytestring */ 356 struct bridge_softc 357 *if_bridge; /* i: bridge glue */ 358 struct bridge_iflist 359 *if_bridgeif; /* i: shortcut to interface list entry */ 360 int if_dlt; /* :: data link type (<net/dlt.h>) */ 361 pfil_head_t * if_pfil; /* :: filtering point */ 362 uint64_t if_capabilities; 363 /* i: interface capabilities */ 364 uint64_t if_capenable; /* i: capabilities enabled */ 365 union { 366 void * carp_s; /* carp structure (used by !carp ifs) */ 367 struct ifnet *carp_d;/* ptr to carpdev (used by carp ifs) */ 368 } if_carp_ptr; /* ?: */ 369 #define if_carp if_carp_ptr.carp_s 370 #define if_carpdev if_carp_ptr.carp_d 371 /* 372 * These are pre-computed based on an interfaces enabled 373 * capabilities, for speed elsewhere. 374 */ 375 int if_csum_flags_tx; 376 /* i: M_CSUM_* flags for Tx */ 377 int if_csum_flags_rx; 378 /* i: M_CSUM_* flags for Rx */ 379 380 void *if_afdata[AF_MAX]; 381 /* a: */ 382 struct mowner *if_mowner; /* ?: who owns mbufs for this interface */ 383 384 void *if_lagg; /* :: lagg or agr structure */ 385 void *if_npf_private;/* ?: associated NPF context */ 386 387 /* 388 * pf specific data, used only when #if NPF > 0. 389 */ 390 void *if_pf_kif; /* ?: pf interface abstraction */ 391 void *if_pf_groups; /* ?: pf interface groups */ 392 /* 393 * During an ifnet's lifetime, it has only one if_index, but 394 * and if_index is not sufficient to identify an ifnet 395 * because during the lifetime of the system, many ifnets may occupy a 396 * given if_index. Let us tell different ifnets at the same 397 * if_index apart by their if_index_gen, a unique number that each ifnet 398 * is assigned when it if_attach()s. Now, the kernel can use the 399 * pair (if_index, if_index_gen) as a weak reference to an ifnet. 400 */ 401 uint64_t if_index_gen; /* :: generation number for the ifnet 402 * at if_index: if two ifnets' index 403 * and generation number are both the 404 * same, they are the same ifnet. 405 */ 406 struct sysctllog 407 *if_sysctl_log; /* :: */ 408 int (*if_initaddr) /* :: */ 409 (struct ifnet *, struct ifaddr *, bool); 410 int (*if_setflags) /* :: */ 411 (struct ifnet *, const u_short); 412 kmutex_t *if_ioctl_lock; /* :: */ 413 char *if_description; /* i: interface description */ 414 #ifdef _KERNEL /* XXX kvm(3) */ 415 struct callout *if_slowtimo_ch;/* :: */ 416 struct krwlock *if_afdata_lock;/* :: */ 417 struct if_percpuq 418 *if_percpuq; /* :: we should remove it in the future */ 419 struct work if_link_work; /* q: linkage on link state work queue */ 420 uint16_t if_link_queue; /* q: masked link state change queue */ 421 /* q: is link state work scheduled? */ 422 bool if_link_scheduled; 423 void (*if_link_state_changed)(struct ifnet *, int); 424 struct pslist_entry 425 if_pslist_entry;/* i: */ 426 struct psref_target 427 if_psref; /* :: */ 428 struct pslist_head 429 if_addr_pslist; /* i: */ 430 struct if_deferred_start 431 *if_deferred_start; 432 /* :: */ 433 /* XXX should be protocol independent */ 434 LIST_HEAD(, in6_multi) 435 if_multiaddrs; /* 6: */ 436 khook_list_t *if_linkstate_hooks; /* :: */ 437 #endif 438 } ifnet_t; 439 440 #include <net/if_stats.h> 441 442 #define if_name(ifp) ((ifp)->if_xname) 443 444 #define IFF_UP 0x0001 /* interface is up */ 445 #define IFF_BROADCAST 0x0002 /* broadcast address valid */ 446 #define IFF_DEBUG 0x0004 /* turn on debugging */ 447 #define IFF_LOOPBACK 0x0008 /* is a loopback net */ 448 #define IFF_POINTOPOINT 0x0010 /* interface is point-to-point link */ 449 /* 0x0020 was IFF_NOTRAILERS */ 450 #define IFF_RUNNING 0x0040 /* resources allocated */ 451 #define IFF_NOARP 0x0080 /* no address resolution protocol */ 452 #define IFF_PROMISC 0x0100 /* receive all packets */ 453 #define IFF_ALLMULTI 0x0200 /* receive all multicast packets */ 454 #define IFF_OACTIVE 0x0400 /* transmission in progress */ 455 #define IFF_SIMPLEX 0x0800 /* can't hear own transmissions */ 456 #define IFF_LINK0 0x1000 /* per link layer defined bit */ 457 #define IFF_LINK1 0x2000 /* per link layer defined bit */ 458 #define IFF_LINK2 0x4000 /* per link layer defined bit */ 459 #define IFF_MULTICAST 0x8000 /* supports multicast */ 460 461 #define IFEF_MPSAFE __BIT(0) /* handlers can run in parallel (see below) */ 462 463 /* 464 * The guidelines for converting an interface to IFEF_MPSAFE are as follows 465 * 466 * Enabling IFEF_MPSAFE on an interface suppresses taking KERNEL_LOCK when 467 * calling the following handlers: 468 * - if_start 469 * - Note that if_transmit is always called without KERNEL_LOCK 470 * - if_output 471 * - if_ioctl 472 * - if_init 473 * - if_stop 474 * 475 * This means that an interface with IFEF_MPSAFE must make the above handlers 476 * MP-safe or take KERNEL_LOCK by itself inside handlers that aren't MP-safe 477 * yet. 478 * 479 * There are some additional restrictions to access member variables of struct 480 * ifnet: 481 * - if_flags 482 * - Must be updated with holding IFNET_LOCK 483 * - You cannot use the flag in Tx/Rx paths anymore because there is no 484 * synchronization on the flag except for IFNET_LOCK 485 * - Note that IFNET_LOCK can't be taken in softint because it's known 486 * that it causes a deadlock 487 * - Some synchronization mechanisms such as pserialize_perform are called 488 * with IFNET_LOCK and also require context switches on every CPUs 489 * that mean softints finish so trying to take IFNET_LOCK in softint 490 * might block on IFNET_LOCK and prevent such synchronization mechanisms 491 * from being completed 492 * - Currently the deadlock occurs only if NET_MPSAFE is enabled, however, 493 * we should deal with the restriction because NET_MPSAFE will be enabled 494 * by default in the future 495 * - if_watchdog and if_timer 496 * - The watchdog framework works only for non-IFEF_MPSAFE interfaces 497 * that rely on KERNEL_LOCK 498 * - Interfaces with IFEF_MPSAFE have to provide its own watchdog mechanism 499 * if needed 500 * - Keep if_watchdog NULL when calling if_attach 501 */ 502 503 #ifdef _KERNEL 504 static __inline bool 505 if_is_mpsafe(struct ifnet *ifp) 506 { 507 508 return ((ifp->if_extflags & IFEF_MPSAFE) != 0); 509 } 510 511 static __inline int 512 if_output_lock(struct ifnet *cifp, struct ifnet *ifp, struct mbuf *m, 513 const struct sockaddr *dst, const struct rtentry *rt) 514 { 515 516 if (if_is_mpsafe(cifp)) { 517 return (*cifp->if_output)(ifp, m, dst, rt); 518 } else { 519 int ret; 520 521 KERNEL_LOCK(1, NULL); 522 ret = (*cifp->if_output)(ifp, m, dst, rt); 523 KERNEL_UNLOCK_ONE(NULL); 524 return ret; 525 } 526 } 527 528 static __inline void 529 if_start_lock(struct ifnet *ifp) 530 { 531 532 if (if_is_mpsafe(ifp)) { 533 (*ifp->if_start)(ifp); 534 } else { 535 KERNEL_LOCK(1, NULL); 536 (*ifp->if_start)(ifp); 537 KERNEL_UNLOCK_ONE(NULL); 538 } 539 } 540 541 #define KERNEL_LOCK_IF_IFP_MPSAFE(ifp) \ 542 do { if (if_is_mpsafe(ifp)) { KERNEL_LOCK(1, NULL); } } while (0) 543 #define KERNEL_UNLOCK_IF_IFP_MPSAFE(ifp) \ 544 do { if (if_is_mpsafe(ifp)) { KERNEL_UNLOCK_ONE(NULL); } } while (0) 545 546 #define KERNEL_LOCK_UNLESS_IFP_MPSAFE(ifp) \ 547 do { if (!if_is_mpsafe(ifp)) { KERNEL_LOCK(1, NULL); } } while (0) 548 #define KERNEL_UNLOCK_UNLESS_IFP_MPSAFE(ifp) \ 549 do { if (!if_is_mpsafe(ifp)) { KERNEL_UNLOCK_ONE(NULL); } } while (0) 550 551 #ifdef _KERNEL_OPT 552 #include "opt_net_mpsafe.h" 553 #endif 554 555 /* XXX explore a better place to define */ 556 #ifdef NET_MPSAFE 557 558 #define KERNEL_LOCK_UNLESS_NET_MPSAFE() do { } while (0) 559 #define KERNEL_UNLOCK_UNLESS_NET_MPSAFE() do { } while (0) 560 561 #define SOFTNET_LOCK_UNLESS_NET_MPSAFE() do { } while (0) 562 #define SOFTNET_UNLOCK_UNLESS_NET_MPSAFE() do { } while (0) 563 564 #define SOFTNET_LOCK_IF_NET_MPSAFE() \ 565 do { mutex_enter(softnet_lock); } while (0) 566 #define SOFTNET_UNLOCK_IF_NET_MPSAFE() \ 567 do { mutex_exit(softnet_lock); } while (0) 568 569 #else /* NET_MPSAFE */ 570 571 #define KERNEL_LOCK_UNLESS_NET_MPSAFE() \ 572 do { KERNEL_LOCK(1, NULL); } while (0) 573 #define KERNEL_UNLOCK_UNLESS_NET_MPSAFE() \ 574 do { KERNEL_UNLOCK_ONE(NULL); } while (0) 575 576 #define SOFTNET_LOCK_UNLESS_NET_MPSAFE() \ 577 do { mutex_enter(softnet_lock); } while (0) 578 #define SOFTNET_UNLOCK_UNLESS_NET_MPSAFE() \ 579 do { mutex_exit(softnet_lock); } while (0) 580 581 #define SOFTNET_LOCK_IF_NET_MPSAFE() do { } while (0) 582 #define SOFTNET_UNLOCK_IF_NET_MPSAFE() do { } while (0) 583 584 #endif /* NET_MPSAFE */ 585 586 #define SOFTNET_KERNEL_LOCK_UNLESS_NET_MPSAFE() \ 587 do { \ 588 SOFTNET_LOCK_UNLESS_NET_MPSAFE(); \ 589 KERNEL_LOCK_UNLESS_NET_MPSAFE(); \ 590 } while (0) 591 592 #define SOFTNET_KERNEL_UNLOCK_UNLESS_NET_MPSAFE() \ 593 do { \ 594 KERNEL_UNLOCK_UNLESS_NET_MPSAFE(); \ 595 SOFTNET_UNLOCK_UNLESS_NET_MPSAFE(); \ 596 } while (0) 597 598 #endif /* _KERNEL */ 599 600 #define IFFBITS \ 601 "\020\1UP\2BROADCAST\3DEBUG\4LOOPBACK\5POINTOPOINT" \ 602 "\7RUNNING\10NOARP\11PROMISC\12ALLMULTI\13OACTIVE\14SIMPLEX" \ 603 "\15LINK0\16LINK1\17LINK2\20MULTICAST" 604 605 /* flags set internally only: */ 606 #define IFF_CANTCHANGE \ 607 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 608 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_PROMISC) 609 610 /* 611 * Some convenience macros used for setting ifi_baudrate. 612 */ 613 #define IF_Kbps(x) ((x) * 1000ULL) /* kilobits/sec. */ 614 #define IF_Mbps(x) (IF_Kbps((x) * 1000ULL)) /* megabits/sec. */ 615 #define IF_Gbps(x) (IF_Mbps((x) * 1000ULL)) /* gigabits/sec. */ 616 617 /* Capabilities that interfaces can advertise. */ 618 /* 0x01 .. 0x40 were previously used */ 619 #define IFCAP_TSOv4 0x00080 /* can do TCPv4 segmentation offload */ 620 #define IFCAP_CSUM_IPv4_Rx 0x00100 /* can do IPv4 header checksums (Rx) */ 621 #define IFCAP_CSUM_IPv4_Tx 0x00200 /* can do IPv4 header checksums (Tx) */ 622 #define IFCAP_CSUM_TCPv4_Rx 0x00400 /* can do IPv4/TCP checksums (Rx) */ 623 #define IFCAP_CSUM_TCPv4_Tx 0x00800 /* can do IPv4/TCP checksums (Tx) */ 624 #define IFCAP_CSUM_UDPv4_Rx 0x01000 /* can do IPv4/UDP checksums (Rx) */ 625 #define IFCAP_CSUM_UDPv4_Tx 0x02000 /* can do IPv4/UDP checksums (Tx) */ 626 #define IFCAP_CSUM_TCPv6_Rx 0x04000 /* can do IPv6/TCP checksums (Rx) */ 627 #define IFCAP_CSUM_TCPv6_Tx 0x08000 /* can do IPv6/TCP checksums (Tx) */ 628 #define IFCAP_CSUM_UDPv6_Rx 0x10000 /* can do IPv6/UDP checksums (Rx) */ 629 #define IFCAP_CSUM_UDPv6_Tx 0x20000 /* can do IPv6/UDP checksums (Tx) */ 630 #define IFCAP_TSOv6 0x40000 /* can do TCPv6 segmentation offload */ 631 #define IFCAP_LRO 0x80000 /* can do Large Receive Offload */ 632 #define IFCAP_MASK 0xfff80 /* currently valid capabilities */ 633 634 #define IFCAPBITS \ 635 "\020" \ 636 "\10TSO4" \ 637 "\11IP4CSUM_Rx" \ 638 "\12IP4CSUM_Tx" \ 639 "\13TCP4CSUM_Rx" \ 640 "\14TCP4CSUM_Tx" \ 641 "\15UDP4CSUM_Rx" \ 642 "\16UDP4CSUM_Tx" \ 643 "\17TCP6CSUM_Rx" \ 644 "\20TCP6CSUM_Tx" \ 645 "\21UDP6CSUM_Rx" \ 646 "\22UDP6CSUM_Tx" \ 647 "\23TSO6" \ 648 "\24LRO" \ 649 650 #define IF_AFDATA_LOCK_INIT(ifp) \ 651 do {(ifp)->if_afdata_lock = rw_obj_alloc();} while (0) 652 653 #define IF_AFDATA_LOCK_DESTROY(ifp) rw_obj_free((ifp)->if_afdata_lock) 654 655 #define IF_AFDATA_WLOCK(ifp) rw_enter((ifp)->if_afdata_lock, RW_WRITER) 656 #define IF_AFDATA_RLOCK(ifp) rw_enter((ifp)->if_afdata_lock, RW_READER) 657 #define IF_AFDATA_WUNLOCK(ifp) rw_exit((ifp)->if_afdata_lock) 658 #define IF_AFDATA_RUNLOCK(ifp) rw_exit((ifp)->if_afdata_lock) 659 #define IF_AFDATA_LOCK(ifp) IF_AFDATA_WLOCK(ifp) 660 #define IF_AFDATA_UNLOCK(ifp) IF_AFDATA_WUNLOCK(ifp) 661 #define IF_AFDATA_TRYLOCK(ifp) rw_tryenter((ifp)->if_afdata_lock, RW_WRITER) 662 663 #define IF_AFDATA_LOCK_ASSERT(ifp) \ 664 KASSERT(rw_lock_held((ifp)->if_afdata_lock)) 665 #define IF_AFDATA_RLOCK_ASSERT(ifp) \ 666 KASSERT(rw_read_held((ifp)->if_afdata_lock)) 667 #define IF_AFDATA_WLOCK_ASSERT(ifp) \ 668 KASSERT(rw_write_held((ifp)->if_afdata_lock)) 669 670 /* 671 * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1) 672 * input routines have queues of messages stored on ifqueue structures 673 * (defined above). Entries are added to and deleted from these structures 674 * by these macros, which should be called with ipl raised to splnet(). 675 */ 676 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 677 #define IF_DROP(ifq) ((ifq)->ifq_drops++) 678 #define IF_ENQUEUE(ifq, m) do { \ 679 (m)->m_nextpkt = 0; \ 680 if ((ifq)->ifq_tail == 0) \ 681 (ifq)->ifq_head = m; \ 682 else \ 683 (ifq)->ifq_tail->m_nextpkt = m; \ 684 (ifq)->ifq_tail = m; \ 685 (ifq)->ifq_len++; \ 686 } while (/*CONSTCOND*/0) 687 #define IF_PREPEND(ifq, m) do { \ 688 (m)->m_nextpkt = (ifq)->ifq_head; \ 689 if ((ifq)->ifq_tail == 0) \ 690 (ifq)->ifq_tail = (m); \ 691 (ifq)->ifq_head = (m); \ 692 (ifq)->ifq_len++; \ 693 } while (/*CONSTCOND*/0) 694 #define IF_DEQUEUE(ifq, m) do { \ 695 (m) = (ifq)->ifq_head; \ 696 if (m) { \ 697 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \ 698 (ifq)->ifq_tail = 0; \ 699 (m)->m_nextpkt = 0; \ 700 (ifq)->ifq_len--; \ 701 } \ 702 } while (/*CONSTCOND*/0) 703 #define IF_POLL(ifq, m) ((m) = (ifq)->ifq_head) 704 #define IF_PURGE(ifq) \ 705 do { \ 706 struct mbuf *__m0; \ 707 \ 708 for (;;) { \ 709 IF_DEQUEUE((ifq), __m0); \ 710 if (__m0 == NULL) \ 711 break; \ 712 else \ 713 m_freem(__m0); \ 714 } \ 715 } while (/*CONSTCOND*/ 0) 716 #define IF_IS_EMPTY(ifq) ((ifq)->ifq_len == 0) 717 718 #ifndef IFQ_MAXLEN 719 #define IFQ_MAXLEN 256 720 #endif 721 #define IFNET_SLOWHZ 1 /* granularity is 1 second */ 722 723 /* 724 * Structure defining statistics and other data kept regarding an address 725 * on a network interface. 726 */ 727 struct ifaddr_data { 728 int64_t ifad_inbytes; 729 int64_t ifad_outbytes; 730 }; 731 732 /* 733 * The ifaddr structure contains information about one address 734 * of an interface. They are maintained by the different address families, 735 * are allocated and attached when an address is set, and are linked 736 * together so all addresses for an interface can be located. 737 */ 738 struct ifaddr { 739 struct sockaddr *ifa_addr; /* address of interface */ 740 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 741 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 742 struct sockaddr *ifa_netmask; /* used to determine subnet */ 743 struct ifnet *ifa_ifp; /* back-pointer to interface */ 744 TAILQ_ENTRY(ifaddr) ifa_list; /* list of addresses for interface */ 745 struct ifaddr_data ifa_data; /* statistics on the address */ 746 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 747 (int, struct rtentry *, const struct rt_addrinfo *); 748 u_int ifa_flags; /* mostly rt_flags for cloning */ 749 int ifa_refcnt; /* count of references */ 750 int ifa_metric; /* cost of going out this interface */ 751 struct ifaddr *(*ifa_getifa)(struct ifaddr *, 752 const struct sockaddr *); 753 uint32_t *ifa_seqno; 754 int16_t ifa_preference; /* preference level for this address */ 755 #ifdef _KERNEL 756 struct pslist_entry ifa_pslist_entry; 757 struct psref_target ifa_psref; 758 #endif 759 }; 760 #define IFA_ROUTE RTF_UP /* (0x01) route installed */ 761 #define IFA_DESTROYING 0x2 762 763 /* 764 * Message format for use in obtaining information about interfaces from 765 * sysctl and the routing socket. We need to force 64-bit alignment if we 766 * aren't using compatibility definitions. 767 */ 768 #if !defined(_KERNEL) || !defined(COMPAT_RTSOCK) 769 #define __align64 __aligned(sizeof(uint64_t)) 770 #else 771 #define __align64 772 #endif 773 struct if_msghdr { 774 u_short ifm_msglen __align64; 775 /* to skip over non-understood messages */ 776 u_char ifm_version; /* future binary compatibility */ 777 u_char ifm_type; /* message type */ 778 int ifm_addrs; /* like rtm_addrs */ 779 int ifm_flags; /* value of if_flags */ 780 u_short ifm_index; /* index for associated ifp */ 781 struct if_data ifm_data __align64; 782 /* statistics and other data about if */ 783 }; 784 785 /* 786 * Message format for use in obtaining information about interface addresses 787 * from sysctl and the routing socket. 788 */ 789 struct ifa_msghdr { 790 u_short ifam_msglen __align64; 791 /* to skip over non-understood messages */ 792 u_char ifam_version; /* future binary compatibility */ 793 u_char ifam_type; /* message type */ 794 u_short ifam_index; /* index for associated ifp */ 795 int ifam_flags; /* value of ifa_flags */ 796 int ifam_addrs; /* like rtm_addrs */ 797 pid_t ifam_pid; /* identify sender */ 798 int ifam_addrflags; /* family specific address flags */ 799 int ifam_metric; /* value of ifa_metric */ 800 }; 801 802 /* 803 * Message format announcing the arrival or departure of a network interface. 804 */ 805 struct if_announcemsghdr { 806 u_short ifan_msglen __align64; 807 /* to skip over non-understood messages */ 808 u_char ifan_version; /* future binary compatibility */ 809 u_char ifan_type; /* message type */ 810 u_short ifan_index; /* index for associated ifp */ 811 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 812 u_short ifan_what; /* what type of announcement */ 813 }; 814 815 #define IFAN_ARRIVAL 0 /* interface arrival */ 816 #define IFAN_DEPARTURE 1 /* interface departure */ 817 818 #undef __align64 819 820 /* 821 * Interface request structure used for socket 822 * ioctl's. All interface ioctl's must have parameter 823 * definitions which begin with ifr_name. The 824 * remainder may be interface specific. 825 */ 826 struct ifreq { 827 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 828 union { 829 struct sockaddr ifru_addr; 830 struct sockaddr ifru_dstaddr; 831 struct sockaddr ifru_broadaddr; 832 struct sockaddr_storage ifru_space; 833 short ifru_flags; 834 int ifru_addrflags; 835 int ifru_metric; 836 int ifru_mtu; 837 int ifru_dlt; 838 u_int ifru_value; 839 void * ifru_data; 840 struct { 841 uint32_t b_buflen; 842 void *b_buf; 843 } ifru_b; 844 } ifr_ifru; 845 #define ifr_addr ifr_ifru.ifru_addr /* address */ 846 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 847 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 848 #define ifr_space ifr_ifru.ifru_space /* sockaddr_storage */ 849 #define ifr_flags ifr_ifru.ifru_flags /* flags */ 850 #define ifr_addrflags ifr_ifru.ifru_addrflags /* addr flags */ 851 #define ifr_metric ifr_ifru.ifru_metric /* metric */ 852 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 853 #define ifr_dlt ifr_ifru.ifru_dlt /* data link type (DLT_*) */ 854 #define ifr_value ifr_ifru.ifru_value /* generic value */ 855 #define ifr_media ifr_ifru.ifru_metric /* media options (overload) */ 856 #define ifr_data ifr_ifru.ifru_data /* for use by interface 857 * XXX deprecated 858 */ 859 #define ifr_buf ifr_ifru.ifru_b.b_buf /* new interface ioctls */ 860 #define ifr_buflen ifr_ifru.ifru_b.b_buflen 861 #define ifr_index ifr_ifru.ifru_value /* interface index, BSD */ 862 #define ifr_ifindex ifr_index /* interface index, linux */ 863 }; 864 865 #ifdef _KERNEL 866 #define ifreq_setdstaddr ifreq_setaddr 867 #define ifreq_setbroadaddr ifreq_setaddr 868 #define ifreq_getdstaddr ifreq_getaddr 869 #define ifreq_getbroadaddr ifreq_getaddr 870 871 static __inline const struct sockaddr * 872 /*ARGSUSED*/ 873 ifreq_getaddr(u_long cmd, const struct ifreq *ifr) 874 { 875 return &ifr->ifr_addr; 876 } 877 #endif /* _KERNEL */ 878 879 struct ifcapreq { 880 char ifcr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 881 uint64_t ifcr_capabilities; /* supported capabiliites */ 882 uint64_t ifcr_capenable; /* capabilities enabled */ 883 }; 884 885 struct ifaliasreq { 886 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 887 struct sockaddr ifra_addr; 888 struct sockaddr ifra_dstaddr; 889 #define ifra_broadaddr ifra_dstaddr 890 struct sockaddr ifra_mask; 891 }; 892 893 struct ifdatareq { 894 char ifdr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 895 struct if_data ifdr_data; 896 }; 897 898 struct ifmediareq { 899 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 900 int ifm_current; /* IFMWD: current media options */ 901 int ifm_mask; /* IFMWD: don't care mask */ 902 int ifm_status; /* media status */ 903 int ifm_active; /* IFMWD: active options */ 904 int ifm_count; /* # entries in ifm_ulist 905 array */ 906 int *ifm_ulist; /* array of ifmedia word */ 907 }; 908 909 910 struct ifdrv { 911 char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 912 unsigned long ifd_cmd; 913 size_t ifd_len; 914 void *ifd_data; 915 }; 916 #define IFLINKSTR_QUERYLEN 0x01 917 #define IFLINKSTR_UNSET 0x02 918 919 /* 920 * Structure used in SIOCGIFCONF request. 921 * Used to retrieve interface configuration 922 * for machine (useful for programs which 923 * must know all networks accessible). 924 */ 925 struct ifconf { 926 int ifc_len; /* size of associated buffer */ 927 union { 928 void * ifcu_buf; 929 struct ifreq *ifcu_req; 930 } ifc_ifcu; 931 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 932 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 933 }; 934 935 /* 936 * Structure for SIOC[AGD]LIFADDR 937 */ 938 struct if_laddrreq { 939 char iflr_name[IFNAMSIZ]; 940 unsigned int flags; 941 #define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ 942 #define IFLR_ACTIVE 0x4000 /* in/out: link-layer address activation */ 943 #define IFLR_FACTORY 0x2000 /* in/out: factory link-layer address */ 944 unsigned int prefixlen; /* in/out */ 945 struct sockaddr_storage addr; /* in/out */ 946 struct sockaddr_storage dstaddr; /* out */ 947 }; 948 949 /* 950 * Structure for SIOC[SG]IFADDRPREF 951 */ 952 struct if_addrprefreq { 953 char ifap_name[IFNAMSIZ]; 954 int16_t ifap_preference; /* in/out */ 955 struct sockaddr_storage ifap_addr; /* in/out */ 956 }; 957 958 #include <net/if_arp.h> 959 960 #endif /* _NETBSD_SOURCE */ 961 962 #ifdef _KERNEL 963 #ifdef ALTQ 964 #define IFQ_ENQUEUE(ifq, m, err) \ 965 do { \ 966 mutex_enter((ifq)->ifq_lock); \ 967 if (ALTQ_IS_ENABLED(ifq)) \ 968 ALTQ_ENQUEUE((ifq), (m), (err)); \ 969 else { \ 970 if (IF_QFULL(ifq)) { \ 971 m_freem(m); \ 972 (err) = ENOBUFS; \ 973 } else { \ 974 IF_ENQUEUE((ifq), (m)); \ 975 (err) = 0; \ 976 } \ 977 } \ 978 if ((err)) \ 979 (ifq)->ifq_drops++; \ 980 mutex_exit((ifq)->ifq_lock); \ 981 } while (/*CONSTCOND*/ 0) 982 983 #define IFQ_DEQUEUE(ifq, m) \ 984 do { \ 985 mutex_enter((ifq)->ifq_lock); \ 986 if (TBR_IS_ENABLED(ifq)) \ 987 (m) = tbr_dequeue((ifq), ALTDQ_REMOVE); \ 988 else if (ALTQ_IS_ENABLED(ifq)) \ 989 ALTQ_DEQUEUE((ifq), (m)); \ 990 else \ 991 IF_DEQUEUE((ifq), (m)); \ 992 mutex_exit((ifq)->ifq_lock); \ 993 } while (/*CONSTCOND*/ 0) 994 995 #define IFQ_POLL(ifq, m) \ 996 do { \ 997 mutex_enter((ifq)->ifq_lock); \ 998 if (TBR_IS_ENABLED(ifq)) \ 999 (m) = tbr_dequeue((ifq), ALTDQ_POLL); \ 1000 else if (ALTQ_IS_ENABLED(ifq)) \ 1001 ALTQ_POLL((ifq), (m)); \ 1002 else \ 1003 IF_POLL((ifq), (m)); \ 1004 mutex_exit((ifq)->ifq_lock); \ 1005 } while (/*CONSTCOND*/ 0) 1006 1007 #define IFQ_PURGE(ifq) \ 1008 do { \ 1009 mutex_enter((ifq)->ifq_lock); \ 1010 if (ALTQ_IS_ENABLED(ifq)) \ 1011 ALTQ_PURGE(ifq); \ 1012 else \ 1013 IF_PURGE(ifq); \ 1014 mutex_exit((ifq)->ifq_lock); \ 1015 } while (/*CONSTCOND*/ 0) 1016 1017 #define IFQ_SET_READY(ifq) \ 1018 do { \ 1019 (ifq)->altq_flags |= ALTQF_READY; \ 1020 } while (/*CONSTCOND*/ 0) 1021 1022 #define IFQ_CLASSIFY(ifq, m, af) \ 1023 do { \ 1024 KASSERT(((m)->m_flags & M_PKTHDR) != 0); \ 1025 mutex_enter((ifq)->ifq_lock); \ 1026 if (ALTQ_IS_ENABLED(ifq)) { \ 1027 if (ALTQ_NEEDS_CLASSIFY(ifq)) \ 1028 (m)->m_pkthdr.pattr_class = (*(ifq)->altq_classify) \ 1029 ((ifq)->altq_clfier, (m), (af)); \ 1030 (m)->m_pkthdr.pattr_af = (af); \ 1031 (m)->m_pkthdr.pattr_hdr = mtod((m), void *); \ 1032 } \ 1033 mutex_exit((ifq)->ifq_lock); \ 1034 } while (/*CONSTCOND*/ 0) 1035 #else /* ! ALTQ */ 1036 #define IFQ_ENQUEUE(ifq, m, err) \ 1037 do { \ 1038 mutex_enter((ifq)->ifq_lock); \ 1039 if (IF_QFULL(ifq)) { \ 1040 m_freem(m); \ 1041 (err) = ENOBUFS; \ 1042 } else { \ 1043 IF_ENQUEUE((ifq), (m)); \ 1044 (err) = 0; \ 1045 } \ 1046 if (err) \ 1047 (ifq)->ifq_drops++; \ 1048 mutex_exit((ifq)->ifq_lock); \ 1049 } while (/*CONSTCOND*/ 0) 1050 1051 #define IFQ_DEQUEUE(ifq, m) \ 1052 do { \ 1053 mutex_enter((ifq)->ifq_lock); \ 1054 IF_DEQUEUE((ifq), (m)); \ 1055 mutex_exit((ifq)->ifq_lock); \ 1056 } while (/*CONSTCOND*/ 0) 1057 1058 #define IFQ_POLL(ifq, m) \ 1059 do { \ 1060 mutex_enter((ifq)->ifq_lock); \ 1061 IF_POLL((ifq), (m)); \ 1062 mutex_exit((ifq)->ifq_lock); \ 1063 } while (/*CONSTCOND*/ 0) 1064 1065 #define IFQ_PURGE(ifq) \ 1066 do { \ 1067 mutex_enter((ifq)->ifq_lock); \ 1068 IF_PURGE(ifq); \ 1069 mutex_exit((ifq)->ifq_lock); \ 1070 } while (/*CONSTCOND*/ 0) 1071 1072 #define IFQ_SET_READY(ifq) /* nothing */ 1073 1074 #define IFQ_CLASSIFY(ifq, m, af) /* nothing */ 1075 1076 #endif /* ALTQ */ 1077 1078 #define IFQ_LOCK_INIT(ifq) (ifq)->ifq_lock = \ 1079 mutex_obj_alloc(MUTEX_DEFAULT, IPL_NET) 1080 #define IFQ_LOCK_DESTROY(ifq) mutex_obj_free((ifq)->ifq_lock) 1081 #define IFQ_LOCK(ifq) mutex_enter((ifq)->ifq_lock) 1082 #define IFQ_UNLOCK(ifq) mutex_exit((ifq)->ifq_lock) 1083 1084 #define IFQ_IS_EMPTY(ifq) IF_IS_EMPTY(ifq) 1085 #define IFQ_INC_LEN(ifq) ((ifq)->ifq_len++) 1086 #define IFQ_DEC_LEN(ifq) (--(ifq)->ifq_len) 1087 #define IFQ_INC_DROPS(ifq) ((ifq)->ifq_drops++) 1088 #define IFQ_SET_MAXLEN(ifq, len) ((ifq)->ifq_maxlen = (len)) 1089 1090 #define IFQ_ENQUEUE_ISR(ifq, m, isr) \ 1091 do { \ 1092 IFQ_LOCK(inq); \ 1093 if (IF_QFULL(inq)) { \ 1094 IF_DROP(inq); \ 1095 IFQ_UNLOCK(inq); \ 1096 m_freem(m); \ 1097 } else { \ 1098 IF_ENQUEUE(inq, m); \ 1099 IFQ_UNLOCK(inq); \ 1100 schednetisr(isr); \ 1101 } \ 1102 } while (/*CONSTCOND*/ 0) 1103 1104 #include <sys/mallocvar.h> 1105 MALLOC_DECLARE(M_IFADDR); 1106 MALLOC_DECLARE(M_IFMADDR); 1107 1108 int ifreq_setaddr(u_long, struct ifreq *, const struct sockaddr *); 1109 1110 struct ifnet *if_alloc(u_char); 1111 void if_free(struct ifnet *); 1112 void if_initname(struct ifnet *, const char *, int); 1113 struct ifaddr *if_dl_create(const struct ifnet *, const struct sockaddr_dl **); 1114 void if_activate_sadl(struct ifnet *, struct ifaddr *, 1115 const struct sockaddr_dl *); 1116 void if_set_sadl(struct ifnet *, const void *, u_char, bool); 1117 void if_alloc_sadl(struct ifnet *); 1118 void if_free_sadl(struct ifnet *, int); 1119 void if_initialize(struct ifnet *); 1120 void if_register(struct ifnet *); 1121 void if_attach(struct ifnet *); /* Deprecated. Use if_initialize and if_register */ 1122 void if_attachdomain(void); 1123 void if_deactivate(struct ifnet *); 1124 bool if_is_deactivated(const struct ifnet *); 1125 void if_export_if_data(struct ifnet *, struct if_data *, bool); 1126 void if_purgeaddrs(struct ifnet *, int, void (*)(struct ifaddr *)); 1127 void if_detach(struct ifnet *); 1128 void if_down(struct ifnet *); 1129 void if_down_locked(struct ifnet *); 1130 void if_link_state_change(struct ifnet *, int); 1131 void if_domain_link_state_change(struct ifnet *, int); 1132 void if_up(struct ifnet *); 1133 void ifinit(void); 1134 void ifinit1(void); 1135 void ifinit_post(void); 1136 int ifaddrpref_ioctl(struct socket *, u_long, void *, struct ifnet *); 1137 extern int (*ifioctl)(struct socket *, u_long, void *, struct lwp *); 1138 int ifioctl_common(struct ifnet *, u_long, void *); 1139 int ifpromisc(struct ifnet *, int); 1140 int ifpromisc_locked(struct ifnet *, int); 1141 int if_addr_init(ifnet_t *, struct ifaddr *, bool); 1142 int if_do_dad(struct ifnet *); 1143 int if_mcast_op(ifnet_t *, const unsigned long, const struct sockaddr *); 1144 int if_flags_set(struct ifnet *, const u_short); 1145 int if_clone_list(int, char *, int *); 1146 1147 struct ifnet *ifunit(const char *); 1148 struct ifnet *if_get(const char *, struct psref *); 1149 ifnet_t *if_byindex(u_int); 1150 ifnet_t *_if_byindex(u_int); 1151 ifnet_t *if_get_byindex(u_int, struct psref *); 1152 ifnet_t *if_get_bylla(const void *, unsigned char, struct psref *); 1153 void if_put(const struct ifnet *, struct psref *); 1154 void if_acquire(struct ifnet *, struct psref *); 1155 #define if_release if_put 1156 1157 int if_tunnel_check_nesting(struct ifnet *, struct mbuf *, int); 1158 percpu_t *if_tunnel_alloc_ro_percpu(void); 1159 void if_tunnel_free_ro_percpu(percpu_t *); 1160 void if_tunnel_ro_percpu_rtcache_free(percpu_t *); 1161 1162 struct tunnel_ro { 1163 struct route *tr_ro; 1164 kmutex_t *tr_lock; 1165 }; 1166 1167 static inline void 1168 if_tunnel_get_ro(percpu_t *ro_percpu, struct route **ro, kmutex_t **lock) 1169 { 1170 struct tunnel_ro *tro; 1171 1172 tro = percpu_getref(ro_percpu); 1173 *ro = tro->tr_ro; 1174 *lock = tro->tr_lock; 1175 mutex_enter(*lock); 1176 } 1177 1178 static inline void 1179 if_tunnel_put_ro(percpu_t *ro_percpu, kmutex_t *lock) 1180 { 1181 1182 mutex_exit(lock); 1183 percpu_putref(ro_percpu); 1184 } 1185 1186 static __inline if_index_t 1187 if_get_index(const struct ifnet *ifp) 1188 { 1189 1190 return ifp != NULL ? ifp->if_index : 0; 1191 } 1192 1193 bool if_held(struct ifnet *); 1194 1195 void if_input(struct ifnet *, struct mbuf *); 1196 1197 struct if_percpuq * 1198 if_percpuq_create(struct ifnet *); 1199 void if_percpuq_destroy(struct if_percpuq *); 1200 void 1201 if_percpuq_enqueue(struct if_percpuq *, struct mbuf *); 1202 1203 void if_deferred_start_init(struct ifnet *, void (*)(struct ifnet *)); 1204 void if_schedule_deferred_start(struct ifnet *); 1205 1206 void ifa_insert(struct ifnet *, struct ifaddr *); 1207 void ifa_remove(struct ifnet *, struct ifaddr *); 1208 1209 void ifa_psref_init(struct ifaddr *); 1210 void ifa_acquire(struct ifaddr *, struct psref *); 1211 void ifa_release(struct ifaddr *, struct psref *); 1212 bool ifa_held(struct ifaddr *); 1213 bool ifa_is_destroying(struct ifaddr *); 1214 1215 void ifaref(struct ifaddr *); 1216 void ifafree(struct ifaddr *); 1217 1218 struct ifaddr *ifa_ifwithaddr(const struct sockaddr *); 1219 struct ifaddr *ifa_ifwithaddr_psref(const struct sockaddr *, struct psref *); 1220 struct ifaddr *ifa_ifwithaf(int); 1221 struct ifaddr *ifa_ifwithdstaddr(const struct sockaddr *); 1222 struct ifaddr *ifa_ifwithdstaddr_psref(const struct sockaddr *, 1223 struct psref *); 1224 struct ifaddr *ifa_ifwithnet(const struct sockaddr *); 1225 struct ifaddr *ifa_ifwithnet_psref(const struct sockaddr *, struct psref *); 1226 struct ifaddr *ifa_ifwithladdr(const struct sockaddr *); 1227 struct ifaddr *ifa_ifwithladdr_psref(const struct sockaddr *, struct psref *); 1228 struct ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *); 1229 struct ifaddr *ifaof_ifpforaddr_psref(const struct sockaddr *, struct ifnet *, 1230 struct psref *); 1231 void link_rtrequest(int, struct rtentry *, const struct rt_addrinfo *); 1232 void p2p_rtrequest(int, struct rtentry *, const struct rt_addrinfo *); 1233 1234 void if_clone_attach(struct if_clone *); 1235 void if_clone_detach(struct if_clone *); 1236 1237 int if_transmit_lock(struct ifnet *, struct mbuf *); 1238 1239 int ifq_enqueue(struct ifnet *, struct mbuf *); 1240 int ifq_enqueue2(struct ifnet *, struct ifqueue *, struct mbuf *); 1241 1242 int loioctl(struct ifnet *, u_long, void *); 1243 void loopattach(int); 1244 void loopinit(void); 1245 int looutput(struct ifnet *, 1246 struct mbuf *, const struct sockaddr *, const struct rtentry *); 1247 1248 void * if_linkstate_change_establish(struct ifnet *, 1249 void (*)(void *), void *); 1250 void if_linkstate_change_disestablish(struct ifnet *, 1251 void *, kmutex_t *); 1252 1253 /* 1254 * These are exported because they're an easy way to tell if 1255 * an interface is going away without having to burn a flag. 1256 */ 1257 int if_nulloutput(struct ifnet *, struct mbuf *, 1258 const struct sockaddr *, const struct rtentry *); 1259 void if_nullinput(struct ifnet *, struct mbuf *); 1260 void if_nullstart(struct ifnet *); 1261 int if_nulltransmit(struct ifnet *, struct mbuf *); 1262 int if_nullioctl(struct ifnet *, u_long, void *); 1263 int if_nullinit(struct ifnet *); 1264 void if_nullstop(struct ifnet *, int); 1265 void if_nullslowtimo(struct ifnet *); 1266 #define if_nullwatchdog if_nullslowtimo 1267 void if_nulldrain(struct ifnet *); 1268 #else 1269 struct if_nameindex { 1270 unsigned int if_index; /* 1, 2, ... */ 1271 char *if_name; /* null terminated name: "le0", ... */ 1272 }; 1273 1274 #include <sys/cdefs.h> 1275 __BEGIN_DECLS 1276 unsigned int if_nametoindex(const char *); 1277 char * if_indextoname(unsigned int, char *); 1278 struct if_nameindex * if_nameindex(void); 1279 void if_freenameindex(struct if_nameindex *); 1280 __END_DECLS 1281 #endif /* _KERNEL */ /* XXX really ALTQ? */ 1282 1283 #ifdef _KERNEL 1284 1285 #define IFADDR_FIRST(__ifp) TAILQ_FIRST(&(__ifp)->if_addrlist) 1286 #define IFADDR_NEXT(__ifa) TAILQ_NEXT((__ifa), ifa_list) 1287 #define IFADDR_FOREACH(__ifa, __ifp) TAILQ_FOREACH(__ifa, \ 1288 &(__ifp)->if_addrlist, ifa_list) 1289 #define IFADDR_FOREACH_SAFE(__ifa, __ifp, __nifa) \ 1290 TAILQ_FOREACH_SAFE(__ifa, \ 1291 &(__ifp)->if_addrlist, ifa_list, __nifa) 1292 #define IFADDR_EMPTY(__ifp) TAILQ_EMPTY(&(__ifp)->if_addrlist) 1293 1294 #define IFADDR_ENTRY_INIT(__ifa) \ 1295 PSLIST_ENTRY_INIT((__ifa), ifa_pslist_entry) 1296 #define IFADDR_ENTRY_DESTROY(__ifa) \ 1297 PSLIST_ENTRY_DESTROY((__ifa), ifa_pslist_entry) 1298 #define IFADDR_READER_EMPTY(__ifp) \ 1299 (PSLIST_READER_FIRST(&(__ifp)->if_addr_pslist, struct ifaddr, \ 1300 ifa_pslist_entry) == NULL) 1301 #define IFADDR_READER_FIRST(__ifp) \ 1302 PSLIST_READER_FIRST(&(__ifp)->if_addr_pslist, struct ifaddr, \ 1303 ifa_pslist_entry) 1304 #define IFADDR_READER_NEXT(__ifa) \ 1305 PSLIST_READER_NEXT((__ifa), struct ifaddr, ifa_pslist_entry) 1306 #define IFADDR_READER_FOREACH(__ifa, __ifp) \ 1307 PSLIST_READER_FOREACH((__ifa), &(__ifp)->if_addr_pslist, struct ifaddr,\ 1308 ifa_pslist_entry) 1309 #define IFADDR_WRITER_INSERT_HEAD(__ifp, __ifa) \ 1310 PSLIST_WRITER_INSERT_HEAD(&(__ifp)->if_addr_pslist, (__ifa), \ 1311 ifa_pslist_entry) 1312 #define IFADDR_WRITER_REMOVE(__ifa) \ 1313 PSLIST_WRITER_REMOVE((__ifa), ifa_pslist_entry) 1314 #define IFADDR_WRITER_FOREACH(__ifa, __ifp) \ 1315 PSLIST_WRITER_FOREACH((__ifa), &(__ifp)->if_addr_pslist, struct ifaddr,\ 1316 ifa_pslist_entry) 1317 #define IFADDR_WRITER_NEXT(__ifp) \ 1318 PSLIST_WRITER_NEXT((__ifp), struct ifaddr, ifa_pslist_entry) 1319 #define IFADDR_WRITER_INSERT_AFTER(__ifp, __new) \ 1320 PSLIST_WRITER_INSERT_AFTER((__ifp), (__new), ifa_pslist_entry) 1321 #define IFADDR_WRITER_EMPTY(__ifp) \ 1322 (PSLIST_WRITER_FIRST(&(__ifp)->if_addr_pslist, struct ifaddr, \ 1323 ifa_pslist_entry) == NULL) 1324 #define IFADDR_WRITER_INSERT_TAIL(__ifp, __new) \ 1325 do { \ 1326 if (IFADDR_WRITER_EMPTY(__ifp)) { \ 1327 IFADDR_WRITER_INSERT_HEAD((__ifp), (__new)); \ 1328 } else { \ 1329 struct ifaddr *__ifa; \ 1330 IFADDR_WRITER_FOREACH(__ifa, (__ifp)) { \ 1331 if (IFADDR_WRITER_NEXT(__ifa) == NULL) {\ 1332 IFADDR_WRITER_INSERT_AFTER(__ifa,\ 1333 (__new)); \ 1334 break; \ 1335 } \ 1336 } \ 1337 } \ 1338 } while (0) 1339 1340 #define IFNET_GLOBAL_LOCK() mutex_enter(&ifnet_mtx) 1341 #define IFNET_GLOBAL_UNLOCK() mutex_exit(&ifnet_mtx) 1342 #define IFNET_GLOBAL_LOCKED() mutex_owned(&ifnet_mtx) 1343 1344 #define IFNET_READER_EMPTY() \ 1345 (PSLIST_READER_FIRST(&ifnet_pslist, struct ifnet, if_pslist_entry) == NULL) 1346 #define IFNET_READER_FIRST() \ 1347 PSLIST_READER_FIRST(&ifnet_pslist, struct ifnet, if_pslist_entry) 1348 #define IFNET_READER_NEXT(__ifp) \ 1349 PSLIST_READER_NEXT((__ifp), struct ifnet, if_pslist_entry) 1350 #define IFNET_READER_FOREACH(__ifp) \ 1351 PSLIST_READER_FOREACH((__ifp), &ifnet_pslist, struct ifnet, \ 1352 if_pslist_entry) 1353 #define IFNET_WRITER_INSERT_HEAD(__ifp) \ 1354 PSLIST_WRITER_INSERT_HEAD(&ifnet_pslist, (__ifp), if_pslist_entry) 1355 #define IFNET_WRITER_REMOVE(__ifp) \ 1356 PSLIST_WRITER_REMOVE((__ifp), if_pslist_entry) 1357 #define IFNET_WRITER_FOREACH(__ifp) \ 1358 PSLIST_WRITER_FOREACH((__ifp), &ifnet_pslist, struct ifnet, \ 1359 if_pslist_entry) 1360 #define IFNET_WRITER_NEXT(__ifp) \ 1361 PSLIST_WRITER_NEXT((__ifp), struct ifnet, if_pslist_entry) 1362 #define IFNET_WRITER_INSERT_AFTER(__ifp, __new) \ 1363 PSLIST_WRITER_INSERT_AFTER((__ifp), (__new), if_pslist_entry) 1364 #define IFNET_WRITER_EMPTY() \ 1365 (PSLIST_WRITER_FIRST(&ifnet_pslist, struct ifnet, if_pslist_entry) == NULL) 1366 #define IFNET_WRITER_INSERT_TAIL(__new) \ 1367 do { \ 1368 if (IFNET_WRITER_EMPTY()) { \ 1369 IFNET_WRITER_INSERT_HEAD(__new); \ 1370 } else { \ 1371 struct ifnet *__ifp; \ 1372 IFNET_WRITER_FOREACH(__ifp) { \ 1373 if (IFNET_WRITER_NEXT(__ifp) == NULL) { \ 1374 IFNET_WRITER_INSERT_AFTER(__ifp,\ 1375 (__new)); \ 1376 break; \ 1377 } \ 1378 } \ 1379 } \ 1380 } while (0) 1381 1382 #define IFNET_LOCK(ifp) mutex_enter((ifp)->if_ioctl_lock) 1383 #define IFNET_UNLOCK(ifp) mutex_exit((ifp)->if_ioctl_lock) 1384 #define IFNET_LOCKED(ifp) mutex_owned((ifp)->if_ioctl_lock) 1385 1386 #define IFNET_ASSERT_UNLOCKED(ifp) \ 1387 KDASSERT(mutex_ownable((ifp)->if_ioctl_lock)) 1388 1389 extern struct pslist_head ifnet_pslist; 1390 extern kmutex_t ifnet_mtx; 1391 1392 extern struct ifnet *lo0ifp; 1393 1394 /* 1395 * ifq sysctl support 1396 */ 1397 int sysctl_ifq(int *name, u_int namelen, void *oldp, 1398 size_t *oldlenp, void *newp, size_t newlen, 1399 struct ifqueue *ifq); 1400 /* symbolic names for terminal (per-protocol) CTL_IFQ_ nodes */ 1401 #define IFQCTL_LEN 1 1402 #define IFQCTL_MAXLEN 2 1403 #define IFQCTL_PEAK 3 1404 #define IFQCTL_DROPS 4 1405 1406 /* 1407 * Hook for if_vlan - needed by if_agr 1408 */ 1409 MODULE_HOOK(if_vlan_vlan_input_hook, void, (struct ifnet *, struct mbuf *)); 1410 1411 #endif /* _KERNEL */ 1412 1413 #endif /* !_NET_IF_H_ */ 1414
Indexes created Thu Sep 25 16:09:42 GMT 2025