1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1982, 1986, 1989, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * From: @(#)if.h 8.1 (Berkeley) 6/10/93 32 * $FreeBSD$ 33 */ 34 35 #ifndef _NET_IF_VAR_H_ 36 #define _NET_IF_VAR_H_ 37 38 /* 39 * Structures defining a network interface, providing a packet 40 * transport mechanism (ala level 0 of the PUP protocols). 41 * 42 * Each interface accepts output datagrams of a specified maximum 43 * length, and provides higher level routines with input datagrams 44 * received from its medium. 45 * 46 * Output occurs when the routine if_output is called, with three parameters: 47 * (*ifp->if_output)(ifp, m, dst, rt) 48 * Here m is the mbuf chain to be sent and dst is the destination address. 49 * The output routine encapsulates the supplied datagram if necessary, 50 * and then transmits it on its medium. 51 * 52 * On input, each interface unwraps the data received by it, and either 53 * places it on the input queue of an internetwork datagram routine 54 * and posts the associated software interrupt, or passes the datagram to a raw 55 * packet input routine. 56 * 57 * Routines exist for locating interfaces by their addresses 58 * or for locating an interface on a certain network, as well as more general 59 * routing and gateway routines maintaining information used to locate 60 * interfaces. These routines live in the files if.c and route.c 61 */ 62 63 struct rtentry; /* ifa_rtrequest */ 64 struct rt_addrinfo; /* ifa_rtrequest */ 65 struct socket; 66 struct carp_if; 67 struct carp_softc; 68 struct ifvlantrunk; 69 struct route; /* if_output */ 70 struct vnet; 71 struct ifmedia; 72 struct netmap_adapter; 73 struct debugnet_methods; 74 75 #ifdef _KERNEL 76 #include <sys/_eventhandler.h> 77 #include <sys/mbuf.h> /* ifqueue only? */ 78 #include <sys/buf_ring.h> 79 #include <net/vnet.h> 80 #endif /* _KERNEL */ 81 #include <sys/ck.h> 82 #include <sys/counter.h> 83 #include <sys/epoch.h> 84 #include <sys/lock.h> /* XXX */ 85 #include <sys/mutex.h> /* struct ifqueue */ 86 #include <sys/rwlock.h> /* XXX */ 87 #include <sys/sx.h> /* XXX */ 88 #include <sys/_task.h> /* if_link_task */ 89 #define IF_DUNIT_NONE -1 90 91 #include <net/altq/if_altq.h> 92 93 CK_STAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */ 94 CK_STAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */ 95 CK_STAILQ_HEAD(ifmultihead, ifmultiaddr); 96 CK_STAILQ_HEAD(ifgrouphead, ifg_group); 97 98 #ifdef _KERNEL 99 VNET_DECLARE(struct pfil_head *, link_pfil_head); 100 #define V_link_pfil_head VNET(link_pfil_head) 101 #define PFIL_ETHER_NAME "ethernet" 102 103 #define HHOOK_IPSEC_INET 0 104 #define HHOOK_IPSEC_INET6 1 105 #define HHOOK_IPSEC_COUNT 2 106 VNET_DECLARE(struct hhook_head *, ipsec_hhh_in[HHOOK_IPSEC_COUNT]); 107 VNET_DECLARE(struct hhook_head *, ipsec_hhh_out[HHOOK_IPSEC_COUNT]); 108 #define V_ipsec_hhh_in VNET(ipsec_hhh_in) 109 #define V_ipsec_hhh_out VNET(ipsec_hhh_out) 110 #endif /* _KERNEL */ 111 112 typedef enum { 113 IFCOUNTER_IPACKETS = 0, 114 IFCOUNTER_IERRORS, 115 IFCOUNTER_OPACKETS, 116 IFCOUNTER_OERRORS, 117 IFCOUNTER_COLLISIONS, 118 IFCOUNTER_IBYTES, 119 IFCOUNTER_OBYTES, 120 IFCOUNTER_IMCASTS, 121 IFCOUNTER_OMCASTS, 122 IFCOUNTER_IQDROPS, 123 IFCOUNTER_OQDROPS, 124 IFCOUNTER_NOPROTO, 125 IFCOUNTERS /* Array size. */ 126 } ift_counter; 127 128 typedef struct ifnet * if_t; 129 130 typedef void (*if_start_fn_t)(if_t); 131 typedef int (*if_ioctl_fn_t)(if_t, u_long, caddr_t); 132 typedef void (*if_init_fn_t)(void *); 133 typedef void (*if_qflush_fn_t)(if_t); 134 typedef int (*if_transmit_fn_t)(if_t, struct mbuf *); 135 typedef uint64_t (*if_get_counter_t)(if_t, ift_counter); 136 137 struct ifnet_hw_tsomax { 138 u_int tsomaxbytes; /* TSO total burst length limit in bytes */ 139 u_int tsomaxsegcount; /* TSO maximum segment count */ 140 u_int tsomaxsegsize; /* TSO maximum segment size in bytes */ 141 }; 142 143 /* Interface encap request types */ 144 typedef enum { 145 IFENCAP_LL = 1 /* pre-calculate link-layer header */ 146 } ife_type; 147 148 /* 149 * The structure below allows to request various pre-calculated L2/L3 headers 150 * for different media. Requests varies by type (rtype field). 151 * 152 * IFENCAP_LL type: pre-calculates link header based on address family 153 * and destination lladdr. 154 * 155 * Input data fields: 156 * buf: pointer to destination buffer 157 * bufsize: buffer size 158 * flags: IFENCAP_FLAG_BROADCAST if destination is broadcast 159 * family: address family defined by AF_ constant. 160 * lladdr: pointer to link-layer address 161 * lladdr_len: length of link-layer address 162 * hdata: pointer to L3 header (optional, used for ARP requests). 163 * Output data fields: 164 * buf: encap data is stored here 165 * bufsize: resulting encap length is stored here 166 * lladdr_off: offset of link-layer address from encap hdr start 167 * hdata: L3 header may be altered if necessary 168 */ 169 170 struct if_encap_req { 171 u_char *buf; /* Destination buffer (w) */ 172 size_t bufsize; /* size of provided buffer (r) */ 173 ife_type rtype; /* request type (r) */ 174 uint32_t flags; /* Request flags (r) */ 175 int family; /* Address family AF_* (r) */ 176 int lladdr_off; /* offset from header start (w) */ 177 int lladdr_len; /* lladdr length (r) */ 178 char *lladdr; /* link-level address pointer (r) */ 179 char *hdata; /* Upper layer header data (rw) */ 180 }; 181 182 #define IFENCAP_FLAG_BROADCAST 0x02 /* Destination is broadcast */ 183 184 /* 185 * Network interface send tag support. The storage of "struct 186 * m_snd_tag" comes from the network driver and it is free to allocate 187 * as much additional space as it wants for its own use. 188 */ 189 struct ktls_session; 190 struct m_snd_tag; 191 192 #define IF_SND_TAG_TYPE_RATE_LIMIT 0 193 #define IF_SND_TAG_TYPE_UNLIMITED 1 194 #define IF_SND_TAG_TYPE_TLS 2 195 #define IF_SND_TAG_TYPE_MAX 3 196 197 struct if_snd_tag_alloc_header { 198 uint32_t type; /* send tag type, see IF_SND_TAG_XXX */ 199 uint32_t flowid; /* mbuf hash value */ 200 uint32_t flowtype; /* mbuf hash type */ 201 uint8_t numa_domain; /* numa domain of associated inp */ 202 }; 203 204 struct if_snd_tag_alloc_rate_limit { 205 struct if_snd_tag_alloc_header hdr; 206 uint64_t max_rate; /* in bytes/s */ 207 uint32_t flags; /* M_NOWAIT or M_WAITOK */ 208 uint32_t reserved; /* alignment */ 209 }; 210 211 struct if_snd_tag_alloc_tls { 212 struct if_snd_tag_alloc_header hdr; 213 struct inpcb *inp; 214 const struct ktls_session *tls; 215 }; 216 217 struct if_snd_tag_rate_limit_params { 218 uint64_t max_rate; /* in bytes/s */ 219 uint32_t queue_level; /* 0 (empty) .. 65535 (full) */ 220 #define IF_SND_QUEUE_LEVEL_MIN 0 221 #define IF_SND_QUEUE_LEVEL_MAX 65535 222 uint32_t flags; /* M_NOWAIT or M_WAITOK */ 223 }; 224 225 union if_snd_tag_alloc_params { 226 struct if_snd_tag_alloc_header hdr; 227 struct if_snd_tag_alloc_rate_limit rate_limit; 228 struct if_snd_tag_alloc_rate_limit unlimited; 229 struct if_snd_tag_alloc_tls tls; 230 }; 231 232 union if_snd_tag_modify_params { 233 struct if_snd_tag_rate_limit_params rate_limit; 234 struct if_snd_tag_rate_limit_params unlimited; 235 }; 236 237 union if_snd_tag_query_params { 238 struct if_snd_tag_rate_limit_params rate_limit; 239 struct if_snd_tag_rate_limit_params unlimited; 240 }; 241 242 /* Query return flags */ 243 #define RT_NOSUPPORT 0x00000000 /* Not supported */ 244 #define RT_IS_INDIRECT 0x00000001 /* 245 * Interface like a lagg, select 246 * the actual interface for 247 * capabilities. 248 */ 249 #define RT_IS_SELECTABLE 0x00000002 /* 250 * No rate table, you select 251 * rates and the first 252 * number_of_rates are created. 253 */ 254 #define RT_IS_FIXED_TABLE 0x00000004 /* A fixed table is attached */ 255 #define RT_IS_UNUSABLE 0x00000008 /* It is not usable for this */ 256 #define RT_IS_SETUP_REQ 0x00000010 /* The interface setup must be called before use */ 257 258 struct if_ratelimit_query_results { 259 const uint64_t *rate_table; /* Pointer to table if present */ 260 uint32_t flags; /* Flags indicating results */ 261 uint32_t max_flows; /* Max flows using, 0=unlimited */ 262 uint32_t number_of_rates; /* How many unique rates can be created */ 263 uint32_t min_segment_burst; /* The amount the adapter bursts at each send */ 264 }; 265 266 typedef int (if_snd_tag_alloc_t)(struct ifnet *, union if_snd_tag_alloc_params *, 267 struct m_snd_tag **); 268 typedef int (if_snd_tag_modify_t)(struct m_snd_tag *, union if_snd_tag_modify_params *); 269 typedef int (if_snd_tag_query_t)(struct m_snd_tag *, union if_snd_tag_query_params *); 270 typedef void (if_snd_tag_free_t)(struct m_snd_tag *); 271 typedef void (if_ratelimit_query_t)(struct ifnet *, 272 struct if_ratelimit_query_results *); 273 typedef int (if_ratelimit_setup_t)(struct ifnet *, uint64_t, uint32_t); 274 275 /* 276 * Structure defining a network interface. 277 */ 278 struct ifnet { 279 /* General book keeping of interface lists. */ 280 CK_STAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained (CK_) */ 281 LIST_ENTRY(ifnet) if_clones; /* interfaces of a cloner */ 282 CK_STAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if (CK_) */ 283 /* protected by if_addr_lock */ 284 u_char if_alloctype; /* if_type at time of allocation */ 285 uint8_t if_numa_domain; /* NUMA domain of device */ 286 /* Driver and protocol specific information that remains stable. */ 287 void *if_softc; /* pointer to driver state */ 288 void *if_llsoftc; /* link layer softc */ 289 void *if_l2com; /* pointer to protocol bits */ 290 const char *if_dname; /* driver name */ 291 int if_dunit; /* unit or IF_DUNIT_NONE */ 292 u_short if_index; /* numeric abbreviation for this if */ 293 short if_index_reserved; /* spare space to grow if_index */ 294 char if_xname[IFNAMSIZ]; /* external name (name + unit) */ 295 char *if_description; /* interface description */ 296 297 /* Variable fields that are touched by the stack and drivers. */ 298 int if_flags; /* up/down, broadcast, etc. */ 299 int if_drv_flags; /* driver-managed status flags */ 300 int if_capabilities; /* interface features & capabilities */ 301 int if_capenable; /* enabled features & capabilities */ 302 void *if_linkmib; /* link-type-specific MIB data */ 303 size_t if_linkmiblen; /* length of above data */ 304 u_int if_refcount; /* reference count */ 305 306 /* These fields are shared with struct if_data. */ 307 uint8_t if_type; /* ethernet, tokenring, etc */ 308 uint8_t if_addrlen; /* media address length */ 309 uint8_t if_hdrlen; /* media header length */ 310 uint8_t if_link_state; /* current link state */ 311 uint32_t if_mtu; /* maximum transmission unit */ 312 uint32_t if_metric; /* routing metric (external only) */ 313 uint64_t if_baudrate; /* linespeed */ 314 uint64_t if_hwassist; /* HW offload capabilities, see IFCAP */ 315 time_t if_epoch; /* uptime at attach or stat reset */ 316 struct timeval if_lastchange; /* time of last administrative change */ 317 318 struct ifaltq if_snd; /* output queue (includes altq) */ 319 struct task if_linktask; /* task for link change events */ 320 struct task if_addmultitask; /* task for SIOCADDMULTI */ 321 322 /* Addresses of different protocol families assigned to this if. */ 323 struct mtx if_addr_lock; /* lock to protect address lists */ 324 /* 325 * if_addrhead is the list of all addresses associated to 326 * an interface. 327 * Some code in the kernel assumes that first element 328 * of the list has type AF_LINK, and contains sockaddr_dl 329 * addresses which store the link-level address and the name 330 * of the interface. 331 * However, access to the AF_LINK address through this 332 * field is deprecated. Use if_addr or ifaddr_byindex() instead. 333 */ 334 struct ifaddrhead if_addrhead; /* linked list of addresses per if */ 335 struct ifmultihead if_multiaddrs; /* multicast addresses configured */ 336 int if_amcount; /* number of all-multicast requests */ 337 struct ifaddr *if_addr; /* pointer to link-level address */ 338 void *if_hw_addr; /* hardware link-level address */ 339 const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */ 340 struct mtx if_afdata_lock; 341 void *if_afdata[AF_MAX]; 342 int if_afdata_initialized; 343 344 /* Additional features hung off the interface. */ 345 u_int if_fib; /* interface FIB */ 346 struct vnet *if_vnet; /* pointer to network stack instance */ 347 struct vnet *if_home_vnet; /* where this ifnet originates from */ 348 struct ifvlantrunk *if_vlantrunk; /* pointer to 802.1q data */ 349 struct bpf_if *if_bpf; /* packet filter structure */ 350 int if_pcount; /* number of promiscuous listeners */ 351 void *if_bridge; /* bridge glue */ 352 void *if_lagg; /* lagg glue */ 353 void *if_pf_kif; /* pf glue */ 354 struct carp_if *if_carp; /* carp interface structure */ 355 struct label *if_label; /* interface MAC label */ 356 struct netmap_adapter *if_netmap; /* netmap(4) softc */ 357 358 /* Various procedures of the layer2 encapsulation and drivers. */ 359 int (*if_output) /* output routine (enqueue) */ 360 (struct ifnet *, struct mbuf *, const struct sockaddr *, 361 struct route *); 362 void (*if_input) /* input routine (from h/w driver) */ 363 (struct ifnet *, struct mbuf *); 364 struct mbuf *(*if_bridge_input)(struct ifnet *, struct mbuf *); 365 int (*if_bridge_output)(struct ifnet *, struct mbuf *, struct sockaddr *, 366 struct rtentry *); 367 void (*if_bridge_linkstate)(struct ifnet *ifp); 368 if_start_fn_t if_start; /* initiate output routine */ 369 if_ioctl_fn_t if_ioctl; /* ioctl routine */ 370 if_init_fn_t if_init; /* Init routine */ 371 int (*if_resolvemulti) /* validate/resolve multicast */ 372 (struct ifnet *, struct sockaddr **, struct sockaddr *); 373 if_qflush_fn_t if_qflush; /* flush any queue */ 374 if_transmit_fn_t if_transmit; /* initiate output routine */ 375 376 void (*if_reassign) /* reassign to vnet routine */ 377 (struct ifnet *, struct vnet *, char *); 378 if_get_counter_t if_get_counter; /* get counter values */ 379 int (*if_requestencap) /* make link header from request */ 380 (struct ifnet *, struct if_encap_req *); 381 382 /* Statistics. */ 383 counter_u64_t if_counters[IFCOUNTERS]; 384 385 /* Stuff that's only temporary and doesn't belong here. */ 386 387 /* 388 * Network adapter TSO limits: 389 * =========================== 390 * 391 * If the "if_hw_tsomax" field is zero the maximum segment 392 * length limit does not apply. If the "if_hw_tsomaxsegcount" 393 * or the "if_hw_tsomaxsegsize" field is zero the TSO segment 394 * count limit does not apply. If all three fields are zero, 395 * there is no TSO limit. 396 * 397 * NOTE: The TSO limits should reflect the values used in the 398 * BUSDMA tag a network adapter is using to load a mbuf chain 399 * for transmission. The TCP/IP network stack will subtract 400 * space for all linklevel and protocol level headers and 401 * ensure that the full mbuf chain passed to the network 402 * adapter fits within the given limits. 403 */ 404 u_int if_hw_tsomax; /* TSO maximum size in bytes */ 405 u_int if_hw_tsomaxsegcount; /* TSO maximum segment count */ 406 u_int if_hw_tsomaxsegsize; /* TSO maximum segment size in bytes */ 407 408 /* 409 * Network adapter send tag support: 410 */ 411 if_snd_tag_alloc_t *if_snd_tag_alloc; 412 if_snd_tag_modify_t *if_snd_tag_modify; 413 if_snd_tag_query_t *if_snd_tag_query; 414 if_snd_tag_free_t *if_snd_tag_free; 415 if_ratelimit_query_t *if_ratelimit_query; 416 if_ratelimit_setup_t *if_ratelimit_setup; 417 418 /* Ethernet PCP */ 419 uint8_t if_pcp; 420 421 /* 422 * Debugnet (Netdump) hooks to be called while in db/panic. 423 */ 424 struct debugnet_methods *if_debugnet_methods; 425 struct epoch_context if_epoch_ctx; 426 427 /* 428 * Spare fields to be added before branching a stable branch, so 429 * that structure can be enhanced without changing the kernel 430 * binary interface. 431 */ 432 int if_ispare[4]; /* general use */ 433 }; 434 435 /* for compatibility with other BSDs */ 436 #define if_name(ifp) ((ifp)->if_xname) 437 438 #define IF_NODOM 255 439 /* 440 * Locks for address lists on the network interface. 441 */ 442 #define IF_ADDR_LOCK_INIT(if) mtx_init(&(if)->if_addr_lock, "if_addr_lock", NULL, MTX_DEF) 443 #define IF_ADDR_LOCK_DESTROY(if) mtx_destroy(&(if)->if_addr_lock) 444 445 #define IF_ADDR_WLOCK(if) mtx_lock(&(if)->if_addr_lock) 446 #define IF_ADDR_WUNLOCK(if) mtx_unlock(&(if)->if_addr_lock) 447 #define IF_ADDR_LOCK_ASSERT(if) MPASS(in_epoch(net_epoch_preempt) || mtx_owned(&(if)->if_addr_lock)) 448 #define IF_ADDR_WLOCK_ASSERT(if) mtx_assert(&(if)->if_addr_lock, MA_OWNED) 449 450 #ifdef _KERNEL 451 /* interface link layer address change event */ 452 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *); 453 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t); 454 /* interface address change event */ 455 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *); 456 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t); 457 typedef void (*ifaddr_event_ext_handler_t)(void *, struct ifnet *, 458 struct ifaddr *, int); 459 EVENTHANDLER_DECLARE(ifaddr_event_ext, ifaddr_event_ext_handler_t); 460 #define IFADDR_EVENT_ADD 0 461 #define IFADDR_EVENT_DEL 1 462 /* new interface arrival event */ 463 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *); 464 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t); 465 /* interface departure event */ 466 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *); 467 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t); 468 /* Interface link state change event */ 469 typedef void (*ifnet_link_event_handler_t)(void *, struct ifnet *, int); 470 EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t); 471 /* Interface up/down event */ 472 #define IFNET_EVENT_UP 0 473 #define IFNET_EVENT_DOWN 1 474 #define IFNET_EVENT_PCP 2 /* priority code point, PCP */ 475 476 typedef void (*ifnet_event_fn)(void *, struct ifnet *ifp, int event); 477 EVENTHANDLER_DECLARE(ifnet_event, ifnet_event_fn); 478 479 /* 480 * interface groups 481 */ 482 struct ifg_group { 483 char ifg_group[IFNAMSIZ]; 484 u_int ifg_refcnt; 485 void *ifg_pf_kif; 486 CK_STAILQ_HEAD(, ifg_member) ifg_members; /* (CK_) */ 487 CK_STAILQ_ENTRY(ifg_group) ifg_next; /* (CK_) */ 488 }; 489 490 struct ifg_member { 491 CK_STAILQ_ENTRY(ifg_member) ifgm_next; /* (CK_) */ 492 struct ifnet *ifgm_ifp; 493 }; 494 495 struct ifg_list { 496 struct ifg_group *ifgl_group; 497 CK_STAILQ_ENTRY(ifg_list) ifgl_next; /* (CK_) */ 498 }; 499 500 #ifdef _SYS_EVENTHANDLER_H_ 501 /* group attach event */ 502 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *); 503 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t); 504 /* group detach event */ 505 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *); 506 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t); 507 /* group change event */ 508 typedef void (*group_change_event_handler_t)(void *, const char *); 509 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t); 510 #endif /* _SYS_EVENTHANDLER_H_ */ 511 512 #define IF_AFDATA_LOCK_INIT(ifp) \ 513 mtx_init(&(ifp)->if_afdata_lock, "if_afdata", NULL, MTX_DEF) 514 515 #define IF_AFDATA_WLOCK(ifp) mtx_lock(&(ifp)->if_afdata_lock) 516 #define IF_AFDATA_WUNLOCK(ifp) mtx_unlock(&(ifp)->if_afdata_lock) 517 #define IF_AFDATA_LOCK(ifp) IF_AFDATA_WLOCK(ifp) 518 #define IF_AFDATA_UNLOCK(ifp) IF_AFDATA_WUNLOCK(ifp) 519 #define IF_AFDATA_TRYLOCK(ifp) mtx_trylock(&(ifp)->if_afdata_lock) 520 #define IF_AFDATA_DESTROY(ifp) mtx_destroy(&(ifp)->if_afdata_lock) 521 522 #define IF_AFDATA_LOCK_ASSERT(ifp) MPASS(in_epoch(net_epoch_preempt) || mtx_owned(&(ifp)->if_afdata_lock)) 523 #define IF_AFDATA_WLOCK_ASSERT(ifp) mtx_assert(&(ifp)->if_afdata_lock, MA_OWNED) 524 #define IF_AFDATA_UNLOCK_ASSERT(ifp) mtx_assert(&(ifp)->if_afdata_lock, MA_NOTOWNED) 525 526 /* 527 * 72 was chosen below because it is the size of a TCP/IP 528 * header (40) + the minimum mss (32). 529 */ 530 #define IF_MINMTU 72 531 #define IF_MAXMTU 65535 532 533 #define TOEDEV(ifp) ((ifp)->if_llsoftc) 534 535 /* 536 * The ifaddr structure contains information about one address 537 * of an interface. They are maintained by the different address families, 538 * are allocated and attached when an address is set, and are linked 539 * together so all addresses for an interface can be located. 540 * 541 * NOTE: a 'struct ifaddr' is always at the beginning of a larger 542 * chunk of malloc'ed memory, where we store the three addresses 543 * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here. 544 */ 545 struct ifaddr { 546 struct sockaddr *ifa_addr; /* address of interface */ 547 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 548 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 549 struct sockaddr *ifa_netmask; /* used to determine subnet */ 550 struct ifnet *ifa_ifp; /* back-pointer to interface */ 551 struct carp_softc *ifa_carp; /* pointer to CARP data */ 552 CK_STAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */ 553 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 554 (int, struct rtentry *, struct rt_addrinfo *); 555 u_short ifa_flags; /* mostly rt_flags for cloning */ 556 #define IFA_ROUTE RTF_UP /* route installed */ 557 #define IFA_RTSELF RTF_HOST /* loopback route to self installed */ 558 u_int ifa_refcnt; /* references to this structure */ 559 560 counter_u64_t ifa_ipackets; 561 counter_u64_t ifa_opackets; 562 counter_u64_t ifa_ibytes; 563 counter_u64_t ifa_obytes; 564 struct epoch_context ifa_epoch_ctx; 565 }; 566 567 struct ifaddr * ifa_alloc(size_t size, int flags); 568 void ifa_free(struct ifaddr *ifa); 569 void ifa_ref(struct ifaddr *ifa); 570 571 /* 572 * Multicast address structure. This is analogous to the ifaddr 573 * structure except that it keeps track of multicast addresses. 574 */ 575 #define IFMA_F_ENQUEUED 0x1 576 struct ifmultiaddr { 577 CK_STAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */ 578 struct sockaddr *ifma_addr; /* address this membership is for */ 579 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */ 580 struct ifnet *ifma_ifp; /* back-pointer to interface */ 581 u_int ifma_refcount; /* reference count */ 582 int ifma_flags; 583 void *ifma_protospec; /* protocol-specific state, if any */ 584 struct ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */ 585 struct epoch_context ifma_epoch_ctx; 586 }; 587 588 extern struct rwlock ifnet_rwlock; 589 extern struct sx ifnet_sxlock; 590 591 #define IFNET_WLOCK() do { \ 592 sx_xlock(&ifnet_sxlock); \ 593 rw_wlock(&ifnet_rwlock); \ 594 } while (0) 595 596 #define IFNET_WUNLOCK() do { \ 597 rw_wunlock(&ifnet_rwlock); \ 598 sx_xunlock(&ifnet_sxlock); \ 599 } while (0) 600 601 /* 602 * To assert the ifnet lock, you must know not only whether it's for read or 603 * write, but also whether it was acquired with sleep support or not. 604 */ 605 #define IFNET_RLOCK_ASSERT() sx_assert(&ifnet_sxlock, SA_SLOCKED) 606 #define IFNET_WLOCK_ASSERT() do { \ 607 sx_assert(&ifnet_sxlock, SA_XLOCKED); \ 608 rw_assert(&ifnet_rwlock, RA_WLOCKED); \ 609 } while (0) 610 611 #define IFNET_RLOCK() sx_slock(&ifnet_sxlock) 612 #define IFNET_RUNLOCK() sx_sunlock(&ifnet_sxlock) 613 614 /* 615 * Look up an ifnet given its index; the _ref variant also acquires a 616 * reference that must be freed using if_rele(). It is almost always a bug 617 * to call ifnet_byindex() instead of ifnet_byindex_ref(). 618 */ 619 struct ifnet *ifnet_byindex(u_short idx); 620 struct ifnet *ifnet_byindex_ref(u_short idx); 621 622 /* 623 * Given the index, ifaddr_byindex() returns the one and only 624 * link-level ifaddr for the interface. You are not supposed to use 625 * it to traverse the list of addresses associated to the interface. 626 */ 627 struct ifaddr *ifaddr_byindex(u_short idx); 628 629 VNET_DECLARE(struct ifnethead, ifnet); 630 VNET_DECLARE(struct ifgrouphead, ifg_head); 631 VNET_DECLARE(int, if_index); 632 VNET_DECLARE(struct ifnet *, loif); /* first loopback interface */ 633 634 #define V_ifnet VNET(ifnet) 635 #define V_ifg_head VNET(ifg_head) 636 #define V_if_index VNET(if_index) 637 #define V_loif VNET(loif) 638 639 #ifdef MCAST_VERBOSE 640 #define MCDPRINTF printf 641 #else 642 #define MCDPRINTF(...) 643 #endif 644 645 int if_addgroup(struct ifnet *, const char *); 646 int if_delgroup(struct ifnet *, const char *); 647 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **); 648 int if_allmulti(struct ifnet *, int); 649 struct ifnet* if_alloc(u_char); 650 struct ifnet* if_alloc_dev(u_char, device_t dev); 651 struct ifnet* if_alloc_domain(u_char, int numa_domain); 652 void if_attach(struct ifnet *); 653 void if_dead(struct ifnet *); 654 int if_delmulti(struct ifnet *, struct sockaddr *); 655 void if_delmulti_ifma(struct ifmultiaddr *); 656 void if_delmulti_ifma_flags(struct ifmultiaddr *, int flags); 657 void if_detach(struct ifnet *); 658 void if_purgeaddrs(struct ifnet *); 659 void if_delallmulti(struct ifnet *); 660 void if_down(struct ifnet *); 661 struct ifmultiaddr * 662 if_findmulti(struct ifnet *, const struct sockaddr *); 663 void if_freemulti(struct ifmultiaddr *ifma); 664 void if_free(struct ifnet *); 665 void if_initname(struct ifnet *, const char *, int); 666 void if_link_state_change(struct ifnet *, int); 667 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3); 668 void if_ref(struct ifnet *); 669 void if_rele(struct ifnet *); 670 int if_setlladdr(struct ifnet *, const u_char *, int); 671 int if_tunnel_check_nesting(struct ifnet *, struct mbuf *, uint32_t, int); 672 void if_up(struct ifnet *); 673 int ifioctl(struct socket *, u_long, caddr_t, struct thread *); 674 int ifpromisc(struct ifnet *, int); 675 struct ifnet *ifunit(const char *); 676 struct ifnet *ifunit_ref(const char *); 677 678 int ifa_add_loopback_route(struct ifaddr *, struct sockaddr *); 679 int ifa_del_loopback_route(struct ifaddr *, struct sockaddr *); 680 int ifa_switch_loopback_route(struct ifaddr *, struct sockaddr *); 681 682 struct ifaddr *ifa_ifwithaddr(const struct sockaddr *); 683 int ifa_ifwithaddr_check(const struct sockaddr *); 684 struct ifaddr *ifa_ifwithbroadaddr(const struct sockaddr *, int); 685 struct ifaddr *ifa_ifwithdstaddr(const struct sockaddr *, int); 686 struct ifaddr *ifa_ifwithnet(const struct sockaddr *, int, int); 687 struct ifaddr *ifa_ifwithroute(int, const struct sockaddr *, struct sockaddr *, 688 u_int); 689 struct ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *); 690 int ifa_preferred(struct ifaddr *, struct ifaddr *); 691 692 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen); 693 694 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp); 695 typedef void if_com_free_t(void *com, u_char type); 696 void if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f); 697 void if_deregister_com_alloc(u_char type); 698 void if_data_copy(struct ifnet *, struct if_data *); 699 uint64_t if_get_counter_default(struct ifnet *, ift_counter); 700 void if_inc_counter(struct ifnet *, ift_counter, int64_t); 701 702 #define IF_LLADDR(ifp) \ 703 LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr)) 704 705 uint64_t if_setbaudrate(if_t ifp, uint64_t baudrate); 706 uint64_t if_getbaudrate(if_t ifp); 707 int if_setcapabilities(if_t ifp, int capabilities); 708 int if_setcapabilitiesbit(if_t ifp, int setbit, int clearbit); 709 int if_getcapabilities(if_t ifp); 710 int if_togglecapenable(if_t ifp, int togglecap); 711 int if_setcapenable(if_t ifp, int capenable); 712 int if_setcapenablebit(if_t ifp, int setcap, int clearcap); 713 int if_getcapenable(if_t ifp); 714 const char *if_getdname(if_t ifp); 715 int if_setdev(if_t ifp, void *dev); 716 int if_setdrvflagbits(if_t ifp, int if_setflags, int clear_flags); 717 int if_getdrvflags(if_t ifp); 718 int if_setdrvflags(if_t ifp, int flags); 719 int if_clearhwassist(if_t ifp); 720 int if_sethwassistbits(if_t ifp, int toset, int toclear); 721 int if_sethwassist(if_t ifp, int hwassist_bit); 722 int if_gethwassist(if_t ifp); 723 int if_setsoftc(if_t ifp, void *softc); 724 void *if_getsoftc(if_t ifp); 725 int if_setflags(if_t ifp, int flags); 726 int if_gethwaddr(if_t ifp, struct ifreq *); 727 int if_setmtu(if_t ifp, int mtu); 728 int if_getmtu(if_t ifp); 729 int if_getmtu_family(if_t ifp, int family); 730 int if_setflagbits(if_t ifp, int set, int clear); 731 int if_getflags(if_t ifp); 732 int if_sendq_empty(if_t ifp); 733 int if_setsendqready(if_t ifp); 734 int if_setsendqlen(if_t ifp, int tx_desc_count); 735 int if_sethwtsomax(if_t ifp, u_int if_hw_tsomax); 736 int if_sethwtsomaxsegcount(if_t ifp, u_int if_hw_tsomaxsegcount); 737 int if_sethwtsomaxsegsize(if_t ifp, u_int if_hw_tsomaxsegsize); 738 u_int if_gethwtsomax(if_t ifp); 739 u_int if_gethwtsomaxsegcount(if_t ifp); 740 u_int if_gethwtsomaxsegsize(if_t ifp); 741 int if_input(if_t ifp, struct mbuf* sendmp); 742 int if_sendq_prepend(if_t ifp, struct mbuf *m); 743 struct mbuf *if_dequeue(if_t ifp); 744 int if_setifheaderlen(if_t ifp, int len); 745 void if_setrcvif(struct mbuf *m, if_t ifp); 746 void if_setvtag(struct mbuf *m, u_int16_t tag); 747 u_int16_t if_getvtag(struct mbuf *m); 748 int if_vlantrunkinuse(if_t ifp); 749 caddr_t if_getlladdr(if_t ifp); 750 void *if_gethandle(u_char); 751 void if_bpfmtap(if_t ifp, struct mbuf *m); 752 void if_etherbpfmtap(if_t ifp, struct mbuf *m); 753 void if_vlancap(if_t ifp); 754 755 /* 756 * Traversing through interface address lists. 757 */ 758 struct sockaddr_dl; 759 typedef u_int iflladdr_cb_t(void *, struct sockaddr_dl *, u_int); 760 u_int if_foreach_lladdr(if_t, iflladdr_cb_t, void *); 761 u_int if_foreach_llmaddr(if_t, iflladdr_cb_t, void *); 762 u_int if_lladdr_count(if_t); 763 u_int if_llmaddr_count(if_t); 764 765 int if_getamcount(if_t ifp); 766 struct ifaddr * if_getifaddr(if_t ifp); 767 768 /* Functions */ 769 void if_setinitfn(if_t ifp, void (*)(void *)); 770 void if_setioctlfn(if_t ifp, int (*)(if_t, u_long, caddr_t)); 771 void if_setstartfn(if_t ifp, void (*)(if_t)); 772 void if_settransmitfn(if_t ifp, if_transmit_fn_t); 773 void if_setqflushfn(if_t ifp, if_qflush_fn_t); 774 void if_setgetcounterfn(if_t ifp, if_get_counter_t); 775 776 /* Revisit the below. These are inline functions originally */ 777 int drbr_inuse_drv(if_t ifp, struct buf_ring *br); 778 struct mbuf* drbr_dequeue_drv(if_t ifp, struct buf_ring *br); 779 int drbr_needs_enqueue_drv(if_t ifp, struct buf_ring *br); 780 int drbr_enqueue_drv(if_t ifp, struct buf_ring *br, struct mbuf *m); 781 782 /* TSO */ 783 void if_hw_tsomax_common(if_t ifp, struct ifnet_hw_tsomax *); 784 int if_hw_tsomax_update(if_t ifp, struct ifnet_hw_tsomax *); 785 786 /* accessors for struct ifreq */ 787 void *ifr_data_get_ptr(void *ifrp); 788 void *ifr_buffer_get_buffer(void *data); 789 size_t ifr_buffer_get_length(void *data); 790 791 int ifhwioctl(u_long, struct ifnet *, caddr_t, struct thread *); 792 793 #ifdef DEVICE_POLLING 794 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS }; 795 796 typedef int poll_handler_t(if_t ifp, enum poll_cmd cmd, int count); 797 int ether_poll_register(poll_handler_t *h, if_t ifp); 798 int ether_poll_deregister(if_t ifp); 799 #endif /* DEVICE_POLLING */ 800 801 #endif /* _KERNEL */ 802 803 #include <net/ifq.h> /* XXXAO: temporary unconditional include */ 804 805 #endif /* !_NET_IF_VAR_H_ */ 806