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