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