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 32 #ifndef _NET_IF_VAR_H_ 33 #define _NET_IF_VAR_H_ 34 35 /* 36 * Structures defining a network interface, providing a packet 37 * transport mechanism (ala level 0 of the PUP protocols). 38 * 39 * Each interface accepts output datagrams of a specified maximum 40 * length, and provides higher level routines with input datagrams 41 * received from its medium. 42 * 43 * Output occurs when the routine if_output is called, with three parameters: 44 * (*ifp->if_output)(ifp, m, dst, ro) 45 * Here m is the mbuf chain to be sent and dst is the destination address. 46 * The output routine encapsulates the supplied datagram if necessary, 47 * and then transmits it on its medium. 48 * 49 * On input, each interface unwraps the data received by it, and either 50 * places it on the input queue of an internetwork datagram routine 51 * and posts the associated software interrupt, or passes the datagram to a raw 52 * packet input routine. 53 * 54 * Routines exist for locating interfaces by their addresses 55 * or for locating an interface on a certain network, as well as more general 56 * routing and gateway routines maintaining information used to locate 57 * interfaces. These routines live in the files if.c and route.c 58 */ 59 60 struct rtentry; /* ifa_rtrequest */ 61 struct socket; 62 struct carp_if; 63 struct carp_softc; 64 struct ifvlantrunk; 65 struct route; /* if_output */ 66 struct vnet; 67 struct ifmedia; 68 struct netmap_adapter; 69 struct debugnet_methods; 70 71 #ifdef _KERNEL 72 #include <sys/_eventhandler.h> 73 #include <sys/mbuf.h> /* ifqueue only? */ 74 #include <sys/buf_ring.h> 75 #include <net/vnet.h> 76 #endif /* _KERNEL */ 77 #include <sys/ck.h> 78 #include <sys/counter.h> 79 #include <sys/epoch.h> 80 #include <sys/lock.h> /* XXX */ 81 #include <sys/mutex.h> /* struct ifqueue */ 82 #include <sys/rwlock.h> /* XXX */ 83 #include <sys/sx.h> /* XXX */ 84 #include <sys/_task.h> /* if_link_task */ 85 #define IF_DUNIT_NONE -1 86 87 #include <net/altq/if_altq.h> 88 89 CK_STAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */ 90 CK_STAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */ 91 CK_STAILQ_HEAD(ifmultihead, ifmultiaddr); 92 CK_STAILQ_HEAD(ifgrouphead, ifg_group); 93 94 #ifdef _KERNEL 95 VNET_DECLARE(struct pfil_head *, link_pfil_head); 96 #define V_link_pfil_head VNET(link_pfil_head) 97 #define PFIL_ETHER_NAME "ethernet" 98 99 #define HHOOK_IPSEC_INET 0 100 #define HHOOK_IPSEC_INET6 1 101 #define HHOOK_IPSEC_COUNT 2 102 VNET_DECLARE(struct hhook_head *, ipsec_hhh_in[HHOOK_IPSEC_COUNT]); 103 VNET_DECLARE(struct hhook_head *, ipsec_hhh_out[HHOOK_IPSEC_COUNT]); 104 #define V_ipsec_hhh_in VNET(ipsec_hhh_in) 105 #define V_ipsec_hhh_out VNET(ipsec_hhh_out) 106 #endif /* _KERNEL */ 107 108 typedef enum { 109 IFCOUNTER_IPACKETS = 0, 110 IFCOUNTER_IERRORS, 111 IFCOUNTER_OPACKETS, 112 IFCOUNTER_OERRORS, 113 IFCOUNTER_COLLISIONS, 114 IFCOUNTER_IBYTES, 115 IFCOUNTER_OBYTES, 116 IFCOUNTER_IMCASTS, 117 IFCOUNTER_OMCASTS, 118 IFCOUNTER_IQDROPS, 119 IFCOUNTER_OQDROPS, 120 IFCOUNTER_NOPROTO, 121 IFCOUNTERS /* Array size. */ 122 } ift_counter; 123 124 typedef void (*if_start_fn_t)(if_t); 125 typedef int (*if_ioctl_fn_t)(if_t, u_long, caddr_t); 126 typedef void (*if_init_fn_t)(void *); 127 typedef void (*if_input_fn_t)(if_t, struct mbuf *); 128 typedef int (*if_output_fn_t)(if_t, struct mbuf *, const struct sockaddr *, 129 struct route *); 130 typedef void (*if_qflush_fn_t)(if_t); 131 typedef int (*if_transmit_fn_t)(if_t, struct mbuf *); 132 typedef uint64_t (*if_get_counter_t)(if_t, ift_counter); 133 typedef void (*if_reassign_fn_t)(if_t, struct vnet *, char *); 134 struct if_vf_status; 135 typedef int (*if_vf_status_fn_t)(if_t, struct if_vf_status **); 136 typedef int (*if_spdadd_fn_t)(if_t ifp, void *sp, void *inp, void **priv); 137 typedef int (*if_spddel_fn_t)(if_t ifp, void *sp, void *priv); 138 typedef int (*if_sa_newkey_fn_t)(if_t ifp, void *sav, u_int drv_spi, 139 void **privp); 140 typedef int (*if_sa_deinstall_fn_t)(if_t ifp, u_int drv_spi, void *priv); 141 struct seclifetime; 142 #define IF_SA_CNT_UPD 0x80000000 143 enum IF_SA_CNT_WHICH { 144 IF_SA_CNT_IFP_HW_VAL = 1, 145 IF_SA_CNT_TOTAL_SW_VAL, 146 IF_SA_CNT_TOTAL_HW_VAL, 147 IF_SA_CNT_IFP_HW_UPD = IF_SA_CNT_IFP_HW_VAL | IF_SA_CNT_UPD, 148 IF_SA_CNT_TOTAL_SW_UPD = IF_SA_CNT_TOTAL_SW_VAL | IF_SA_CNT_UPD, 149 IF_SA_CNT_TOTAL_HW_UPD = IF_SA_CNT_TOTAL_HW_VAL | IF_SA_CNT_UPD, 150 }; 151 typedef int (*if_sa_cnt_fn_t)(if_t ifp, void *sa, 152 uint32_t drv_spi, void *priv, struct seclifetime *lt); 153 typedef int (*if_ipsec_hwassist_fn_t)(if_t ifp, void *sav, 154 u_int drv_spi,void *priv); 155 156 struct ifnet_hw_tsomax { 157 u_int tsomaxbytes; /* TSO total burst length limit in bytes */ 158 u_int tsomaxsegcount; /* TSO maximum segment count */ 159 u_int tsomaxsegsize; /* TSO maximum segment size in bytes */ 160 }; 161 162 /* Interface encap request types */ 163 typedef enum { 164 IFENCAP_LL = 1 /* pre-calculate link-layer header */ 165 } ife_type; 166 167 /* 168 * The structure below allows to request various pre-calculated L2/L3 headers 169 * for different media. Requests varies by type (rtype field). 170 * 171 * IFENCAP_LL type: pre-calculates link header based on address family 172 * and destination lladdr. 173 * 174 * Input data fields: 175 * buf: pointer to destination buffer 176 * bufsize: buffer size 177 * flags: IFENCAP_FLAG_BROADCAST if destination is broadcast 178 * family: address family defined by AF_ constant. 179 * lladdr: pointer to link-layer address 180 * lladdr_len: length of link-layer address 181 * hdata: pointer to L3 header (optional, used for ARP requests). 182 * Output data fields: 183 * buf: encap data is stored here 184 * bufsize: resulting encap length is stored here 185 * lladdr_off: offset of link-layer address from encap hdr start 186 * hdata: L3 header may be altered if necessary 187 */ 188 189 struct if_encap_req { 190 u_char *buf; /* Destination buffer (w) */ 191 size_t bufsize; /* size of provided buffer (r) */ 192 ife_type rtype; /* request type (r) */ 193 uint32_t flags; /* Request flags (r) */ 194 int family; /* Address family AF_* (r) */ 195 int lladdr_off; /* offset from header start (w) */ 196 int lladdr_len; /* lladdr length (r) */ 197 char *lladdr; /* link-level address pointer (r) */ 198 char *hdata; /* Upper layer header data (rw) */ 199 }; 200 201 #define IFENCAP_FLAG_BROADCAST 0x02 /* Destination is broadcast */ 202 203 /* 204 * Network interface send tag support. The storage of "struct 205 * m_snd_tag" comes from the network driver and it is free to allocate 206 * as much additional space as it wants for its own use. 207 */ 208 struct ktls_session; 209 struct m_snd_tag; 210 211 #define IF_SND_TAG_TYPE_RATE_LIMIT 0 212 #define IF_SND_TAG_TYPE_UNLIMITED 1 213 #define IF_SND_TAG_TYPE_TLS 2 214 #define IF_SND_TAG_TYPE_TLS_RATE_LIMIT 3 215 #define IF_SND_TAG_TYPE_TLS_RX 4 216 #define IF_SND_TAG_TYPE_MAX 5 217 218 struct if_snd_tag_alloc_header { 219 uint32_t type; /* send tag type, see IF_SND_TAG_XXX */ 220 uint32_t flowid; /* mbuf hash value */ 221 uint32_t flowtype; /* mbuf hash type */ 222 uint8_t numa_domain; /* numa domain of associated inp */ 223 }; 224 225 struct if_snd_tag_alloc_rate_limit { 226 struct if_snd_tag_alloc_header hdr; 227 uint64_t max_rate; /* in bytes/s */ 228 uint32_t flags; /* M_NOWAIT or M_WAITOK */ 229 uint32_t reserved; /* alignment */ 230 }; 231 232 struct if_snd_tag_alloc_tls { 233 struct if_snd_tag_alloc_header hdr; 234 struct inpcb *inp; 235 const struct ktls_session *tls; 236 }; 237 238 struct if_snd_tag_alloc_tls_rx { 239 struct if_snd_tag_alloc_header hdr; 240 struct inpcb *inp; 241 const struct ktls_session *tls; 242 uint16_t vlan_id; /* valid if non-zero */ 243 }; 244 245 struct if_snd_tag_alloc_tls_rate_limit { 246 struct if_snd_tag_alloc_header hdr; 247 struct inpcb *inp; 248 const struct ktls_session *tls; 249 uint64_t max_rate; /* in bytes/s */ 250 }; 251 252 struct if_snd_tag_rate_limit_params { 253 uint64_t max_rate; /* in bytes/s */ 254 uint32_t queue_level; /* 0 (empty) .. 65535 (full) */ 255 #define IF_SND_QUEUE_LEVEL_MIN 0 256 #define IF_SND_QUEUE_LEVEL_MAX 65535 257 uint32_t flags; /* M_NOWAIT or M_WAITOK */ 258 }; 259 260 struct if_snd_tag_modify_tls_rx { 261 /* TCP sequence number of TLS header in host endian format */ 262 uint32_t tls_hdr_tcp_sn; 263 264 /* 265 * TLS record length, including all headers, data and trailers. 266 * If the tls_rec_length is zero, it means HW encryption resumed. 267 */ 268 uint32_t tls_rec_length; 269 270 /* TLS sequence number in host endian format */ 271 uint64_t tls_seq_number; 272 }; 273 274 union if_snd_tag_alloc_params { 275 struct if_snd_tag_alloc_header hdr; 276 struct if_snd_tag_alloc_rate_limit rate_limit; 277 struct if_snd_tag_alloc_rate_limit unlimited; 278 struct if_snd_tag_alloc_tls tls; 279 struct if_snd_tag_alloc_tls_rx tls_rx; 280 struct if_snd_tag_alloc_tls_rate_limit tls_rate_limit; 281 }; 282 283 union if_snd_tag_modify_params { 284 struct if_snd_tag_rate_limit_params rate_limit; 285 struct if_snd_tag_rate_limit_params unlimited; 286 struct if_snd_tag_rate_limit_params tls_rate_limit; 287 struct if_snd_tag_modify_tls_rx tls_rx; 288 }; 289 290 union if_snd_tag_query_params { 291 struct if_snd_tag_rate_limit_params rate_limit; 292 struct if_snd_tag_rate_limit_params unlimited; 293 struct if_snd_tag_rate_limit_params tls_rate_limit; 294 }; 295 296 typedef int (if_snd_tag_alloc_t)(if_t, union if_snd_tag_alloc_params *, 297 struct m_snd_tag **); 298 typedef int (if_snd_tag_modify_t)(struct m_snd_tag *, union if_snd_tag_modify_params *); 299 typedef int (if_snd_tag_query_t)(struct m_snd_tag *, union if_snd_tag_query_params *); 300 typedef void (if_snd_tag_free_t)(struct m_snd_tag *); 301 typedef struct m_snd_tag *(if_next_send_tag_t)(struct m_snd_tag *); 302 typedef int (if_snd_tag_status_str_t)(struct m_snd_tag *, char *buf, size_t *sz); 303 304 struct if_snd_tag_sw { 305 if_snd_tag_modify_t *snd_tag_modify; 306 if_snd_tag_query_t *snd_tag_query; 307 if_snd_tag_free_t *snd_tag_free; 308 if_next_send_tag_t *next_snd_tag; 309 if_snd_tag_status_str_t *snd_tag_status_str; 310 u_int type; /* One of IF_SND_TAG_TYPE_*. */ 311 }; 312 313 /* Query return flags */ 314 #define RT_NOSUPPORT 0x00000000 /* Not supported */ 315 #define RT_IS_INDIRECT 0x00000001 /* 316 * Interface like a lagg, select 317 * the actual interface for 318 * capabilities. 319 */ 320 #define RT_IS_SELECTABLE 0x00000002 /* 321 * No rate table, you select 322 * rates and the first 323 * number_of_rates are created. 324 */ 325 #define RT_IS_FIXED_TABLE 0x00000004 /* A fixed table is attached */ 326 #define RT_IS_UNUSABLE 0x00000008 /* It is not usable for this */ 327 #define RT_IS_SETUP_REQ 0x00000010 /* The interface setup must be called before use */ 328 329 struct if_ratelimit_query_results { 330 const uint64_t *rate_table; /* Pointer to table if present */ 331 uint32_t flags; /* Flags indicating results */ 332 uint32_t max_flows; /* Max flows using, 0=unlimited */ 333 uint32_t number_of_rates; /* How many unique rates can be created */ 334 uint32_t min_segment_burst; /* The amount the adapter bursts at each send */ 335 }; 336 337 typedef void (if_ratelimit_query_t)(if_t, 338 struct if_ratelimit_query_results *); 339 typedef int (if_ratelimit_setup_t)(if_t, uint64_t, uint32_t); 340 #define IF_NODOM 255 341 /* 342 * Locks for address lists on the network interface. 343 */ 344 #define IF_ADDR_LOCK_INIT(if) mtx_init(&(if)->if_addr_lock, "if_addr_lock", NULL, MTX_DEF) 345 #define IF_ADDR_LOCK_DESTROY(if) mtx_destroy(&(if)->if_addr_lock) 346 347 #define IF_ADDR_WLOCK(if) mtx_lock(&(if)->if_addr_lock) 348 #define IF_ADDR_WUNLOCK(if) mtx_unlock(&(if)->if_addr_lock) 349 #define IF_ADDR_LOCK_ASSERT(if) MPASS(in_epoch(net_epoch_preempt) || mtx_owned(&(if)->if_addr_lock)) 350 #define IF_ADDR_WLOCK_ASSERT(if) mtx_assert(&(if)->if_addr_lock, MA_OWNED) 351 352 #ifdef _KERNEL 353 /* interface link layer address change event */ 354 typedef void (*iflladdr_event_handler_t)(void *, if_t); 355 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t); 356 /* interface address change event */ 357 typedef void (*ifaddr_event_handler_t)(void *, if_t); 358 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t); 359 typedef void (*ifaddr_event_ext_handler_t)(void *, if_t, struct ifaddr *, int); 360 EVENTHANDLER_DECLARE(ifaddr_event_ext, ifaddr_event_ext_handler_t); 361 #define IFADDR_EVENT_ADD 0 362 #define IFADDR_EVENT_DEL 1 363 364 /* 365 * Interface arrival & departure events. 366 * The ifnet_arrival_event is executed before the interface is yet globally 367 * visible. Protocols shall use this event to attach themselves. Protocols 368 * shall not expect other protocols to be fully attached. 369 * The ifnet_attached_event is executed after the interface is attached to all 370 * protocols, is globally visible and fully functional. 371 * The ifnet_departure_event is complementary to ifnet_arrival_event. The 372 * interface is no longer globally visible, protocols may detach. 373 * XXXGL: immediate memory reclamation may not be safe in ifnet_departure_event. 374 * The ifnet_rename_event is executed after an interface is renamed. The 375 * handlers would see the new name of the interface, and are also passed with 376 * old name in the argument. 377 */ 378 typedef void (*ifnet_event_handler_t)(void *, if_t); 379 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_event_handler_t); 380 EVENTHANDLER_DECLARE(ifnet_attached_event, ifnet_event_handler_t); 381 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_event_handler_t); 382 typedef void (*ifnet_rename_event_handler_t)(void *, if_t, const char *); 383 EVENTHANDLER_DECLARE(ifnet_rename_event, ifnet_rename_event_handler_t); 384 385 /* Interface link state change event */ 386 typedef void (*ifnet_link_event_handler_t)(void *, if_t, int); 387 EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t); 388 /* Interface up/down event */ 389 #define IFNET_EVENT_UP 0 390 #define IFNET_EVENT_DOWN 1 391 #define IFNET_EVENT_PCP 2 /* priority code point, PCP */ 392 #define IFNET_EVENT_UPDATE_BAUDRATE 3 393 394 typedef void (*ifnet_event_fn)(void *, if_t ifp, int event); 395 EVENTHANDLER_DECLARE(ifnet_event, ifnet_event_fn); 396 397 /* 398 * interface groups 399 */ 400 struct ifg_group { 401 char ifg_group[IFNAMSIZ]; 402 u_int ifg_refcnt; 403 void *ifg_pf_kif; 404 CK_STAILQ_HEAD(, ifg_member) ifg_members; 405 CK_STAILQ_ENTRY(ifg_group) ifg_next; 406 }; 407 408 struct ifg_member { 409 CK_STAILQ_ENTRY(ifg_member) ifgm_next; 410 if_t ifgm_ifp; 411 }; 412 413 struct ifg_list { 414 struct ifg_group *ifgl_group; 415 CK_STAILQ_ENTRY(ifg_list) ifgl_next; 416 }; 417 418 #ifdef _SYS_EVENTHANDLER_H_ 419 /* group attach event */ 420 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *); 421 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t); 422 /* group detach event */ 423 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *); 424 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t); 425 /* group change event */ 426 typedef void (*group_change_event_handler_t)(void *, const char *); 427 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t); 428 #endif /* _SYS_EVENTHANDLER_H_ */ 429 430 /* 431 * 72 was chosen below because it is the size of a TCP/IP 432 * header (40) + the minimum mss (32). 433 */ 434 #define IF_MINMTU 72 435 #define IF_MAXMTU 65535 436 437 #define TOEDEV(ifp) if_getllsoftc(ifp) 438 #define SETTOEDEV(ifp, sc) if_setllsoftc((ifp), (sc)) 439 440 /* 441 * The ifaddr structure contains information about one address 442 * of an interface. They are maintained by the different address families, 443 * are allocated and attached when an address is set, and are linked 444 * together so all addresses for an interface can be located. 445 * 446 * NOTE: a 'struct ifaddr' is always at the beginning of a larger 447 * chunk of malloc'ed memory, where we store the three addresses 448 * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here. 449 */ 450 struct ifaddr { 451 struct sockaddr *ifa_addr; /* address of interface */ 452 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 453 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 454 struct sockaddr *ifa_netmask; /* used to determine subnet */ 455 if_t ifa_ifp; /* back-pointer to interface */ 456 struct carp_softc *ifa_carp; /* pointer to CARP data */ 457 CK_STAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */ 458 u_short ifa_flags; /* mostly rt_flags for cloning */ 459 #define IFA_ROUTE RTF_UP /* route installed */ 460 #define IFA_RTSELF RTF_HOST /* loopback route to self installed */ 461 u_int ifa_refcnt; /* references to this structure */ 462 463 counter_u64_t ifa_ipackets; 464 counter_u64_t ifa_opackets; 465 counter_u64_t ifa_ibytes; 466 counter_u64_t ifa_obytes; 467 struct epoch_context ifa_epoch_ctx; 468 }; 469 470 struct ifaddr * ifa_alloc(size_t size, int flags); 471 void ifa_free(struct ifaddr *ifa); 472 void ifa_ref(struct ifaddr *ifa); 473 int __result_use_check ifa_try_ref(struct ifaddr *ifa); 474 475 /* 476 * Multicast address structure. This is analogous to the ifaddr 477 * structure except that it keeps track of multicast addresses. 478 */ 479 #define IFMA_F_ENQUEUED 0x1 480 struct ifmultiaddr { 481 CK_STAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */ 482 struct sockaddr *ifma_addr; /* address this membership is for */ 483 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */ 484 if_t ifma_ifp; /* back-pointer to interface */ 485 u_int ifma_refcount; /* reference count */ 486 int ifma_flags; 487 void *ifma_protospec; /* protocol-specific state, if any */ 488 struct ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */ 489 struct epoch_context ifma_epoch_ctx; 490 }; 491 492 extern struct sx ifnet_sxlock; 493 494 #define IFNET_WLOCK() sx_xlock(&ifnet_sxlock) 495 #define IFNET_WUNLOCK() sx_xunlock(&ifnet_sxlock) 496 #define IFNET_RLOCK_ASSERT() sx_assert(&ifnet_sxlock, SA_SLOCKED) 497 #define IFNET_WLOCK_ASSERT() sx_assert(&ifnet_sxlock, SA_XLOCKED) 498 #define IFNET_RLOCK() sx_slock(&ifnet_sxlock) 499 #define IFNET_RUNLOCK() sx_sunlock(&ifnet_sxlock) 500 501 /* 502 * Look up an ifnet given its index. The returned value protected from 503 * being freed by the network epoch. The _ref variant also acquires a 504 * reference that must be freed using if_rele(). 505 */ 506 if_t ifnet_byindex(u_int); 507 if_t ifnet_byindex_ref(u_int); 508 509 /* 510 * ifnet_byindexgen() looks up ifnet by index and generation count, 511 * attempting to restore a weak pointer that had been stored across 512 * the epoch. 513 */ 514 if_t ifnet_byindexgen(uint16_t idx, uint16_t gen); 515 516 VNET_DECLARE(struct ifnethead, ifnet); 517 VNET_DECLARE(struct ifgrouphead, ifg_head); 518 VNET_DECLARE(if_t, loif); /* first loopback interface */ 519 520 #define V_ifnet VNET(ifnet) 521 #define V_ifg_head VNET(ifg_head) 522 #define V_loif VNET(loif) 523 524 #ifdef MCAST_VERBOSE 525 #define MCDPRINTF printf 526 #else 527 #define MCDPRINTF(...) 528 #endif 529 530 typedef int (*if_foreach_group_cb_t)(struct ifg_group *, void *); 531 int if_foreach_group(if_t, if_foreach_group_cb_t, void *); 532 int if_addgroup(if_t, const char *); 533 int if_delgroup(if_t, const char *); 534 int if_addmulti(if_t, struct sockaddr *, struct ifmultiaddr **); 535 int if_allmulti(if_t, int); 536 if_t if_alloc(u_char); 537 if_t if_alloc_dev(u_char, device_t dev); 538 void if_attach(if_t); 539 void if_dead(if_t); 540 int if_delmulti(if_t, struct sockaddr *); 541 void if_delmulti_ifma(struct ifmultiaddr *); 542 void if_delmulti_ifma_flags(struct ifmultiaddr *, int flags); 543 void if_detach(if_t); 544 void if_purgeaddrs(if_t); 545 void if_delallmulti(if_t); 546 void if_down(if_t); 547 struct ifmultiaddr * 548 if_findmulti(if_t, const struct sockaddr *); 549 void if_freemulti(struct ifmultiaddr *ifma); 550 void if_free(if_t); 551 void if_initname(if_t, const char *, int); 552 void if_link_state_change(if_t, int); 553 int if_printf(if_t, const char *, ...) __printflike(2, 3); 554 int if_log(if_t, int, const char *, ...) __printflike(3, 4); 555 void if_ref(if_t); 556 void if_rele(if_t); 557 bool __result_use_check if_try_ref(if_t); 558 int if_setlladdr(if_t, const u_char *, int); 559 int if_tunnel_check_nesting(if_t, struct mbuf *, uint32_t, int); 560 void if_up(if_t); 561 int ifioctl(struct socket *, u_long, caddr_t, struct thread *); 562 int ifpromisc(if_t, int); 563 if_t ifunit(const char *); 564 if_t ifunit_ref(const char *); 565 566 int ifa_add_loopback_route(struct ifaddr *, struct sockaddr *); 567 int ifa_del_loopback_route(struct ifaddr *, struct sockaddr *); 568 int ifa_switch_loopback_route(struct ifaddr *, struct sockaddr *); 569 570 struct ifaddr *ifa_ifwithaddr_fib(const struct sockaddr *, int); 571 struct ifaddr *ifa_ifwithaddr(const struct sockaddr *); 572 int ifa_ifwithaddr_fib_check(const struct sockaddr *, int); 573 int ifa_ifwithaddr_check(const struct sockaddr *); 574 struct ifaddr *ifa_ifwithbroadaddr(const struct sockaddr *, int); 575 struct ifaddr *ifa_ifwithdstaddr(const struct sockaddr *, int); 576 struct ifaddr *ifa_ifwithnet(const struct sockaddr *, int, int); 577 struct ifaddr *ifa_ifwithroute(int, const struct sockaddr *, 578 const struct sockaddr *, u_int); 579 struct ifaddr *ifaof_ifpforaddr(const struct sockaddr *, if_t); 580 int ifa_preferred(struct ifaddr *, struct ifaddr *); 581 582 int if_simloop(if_t ifp, struct mbuf *m, int af, int hlen); 583 584 typedef void *if_com_alloc_t(u_char type, if_t ifp); 585 typedef void if_com_free_t(void *com, u_char type); 586 void if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f); 587 void if_deregister_com_alloc(u_char type); 588 void if_data_copy(if_t, struct if_data *); 589 uint64_t if_get_counter_default(if_t, ift_counter); 590 void if_inc_counter(if_t, ift_counter, int64_t); 591 592 uint64_t if_setbaudrate(if_t ifp, uint64_t baudrate); 593 uint64_t if_getbaudrate(const if_t ifp); 594 int if_setcapabilities(if_t ifp, int capabilities); 595 int if_setcapabilitiesbit(if_t ifp, int setbit, int clearbit); 596 int if_getcapabilities(const if_t ifp); 597 int if_togglecapenable(if_t ifp, int togglecap); 598 int if_setcapenable(if_t ifp, int capenable); 599 int if_setcapenablebit(if_t ifp, int setcap, int clearcap); 600 int if_getcapenable(const if_t ifp); 601 int if_setcapabilities2(if_t ifp, int capabilities); 602 int if_setcapabilities2bit(if_t ifp, int setbit, int clearbit); 603 int if_getcapabilities2(const if_t ifp); 604 int if_togglecapenable2(if_t ifp, int togglecap); 605 int if_setcapenable2(if_t ifp, int capenable); 606 int if_setcapenable2bit(if_t ifp, int setcap, int clearcap); 607 int if_getcapenable2(const if_t ifp); 608 int if_getdunit(const if_t ifp); 609 int if_getindex(const if_t ifp); 610 int if_getidxgen(const if_t ifp); 611 const char *if_getdname(const if_t ifp); 612 void if_setdname(if_t ifp, const char *name); 613 const char *if_name(if_t ifp); 614 int if_setname(if_t ifp, const char *name); 615 int if_rename(if_t ifp, char *new_name); 616 const char *if_getdescr(if_t ifp); 617 void if_setdescr(if_t ifp, char *descrbuf); 618 char *if_allocdescr(size_t sz, int malloc_flag); 619 void if_freedescr(char *descrbuf); 620 void if_setlastchange(if_t ifp); 621 int if_getalloctype(const if_t ifp); 622 int if_gettype(const if_t ifp); 623 int if_setdev(if_t ifp, void *dev); 624 int if_setdrvflagbits(if_t ifp, int if_setflags, int clear_flags); 625 int if_getdrvflags(const if_t ifp); 626 int if_setdrvflags(if_t ifp, int flags); 627 int if_getlinkstate(if_t ifp); 628 int if_clearhwassist(if_t ifp); 629 int if_sethwassistbits(if_t ifp, int toset, int toclear); 630 int if_sethwassist(if_t ifp, int hwassist_bit); 631 int if_gethwassist(const if_t ifp); 632 int if_togglehwassist(if_t ifp, int toggle_bits); 633 int if_setsoftc(if_t ifp, void *softc); 634 void *if_getsoftc(if_t ifp); 635 int if_setflags(if_t ifp, int flags); 636 void if_setllsoftc(if_t ifp, void *softc); 637 void *if_getllsoftc(if_t ifp); 638 u_int if_getfib(if_t ifp); 639 uint8_t if_getaddrlen(if_t ifp); 640 int if_gethwaddr(const if_t ifp, struct ifreq *); 641 const uint8_t *if_getbroadcastaddr(const if_t ifp); 642 void if_setbroadcastaddr(if_t ifp, const uint8_t *); 643 int if_setmtu(if_t ifp, int mtu); 644 int if_getmtu(const if_t ifp); 645 void if_notifymtu(if_t ifp); 646 void if_setppromisc(const if_t ifp, bool ppromisc); 647 int if_setflagbits(if_t ifp, int set, int clear); 648 int if_setflags(if_t ifp, int flags); 649 int if_getflags(const if_t ifp); 650 int if_getnumadomain(if_t ifp); 651 int if_sendq_empty(if_t ifp); 652 int if_setsendqready(if_t ifp); 653 int if_setsendqlen(if_t ifp, int tx_desc_count); 654 int if_sethwtsomax(if_t ifp, u_int if_hw_tsomax); 655 int if_sethwtsomaxsegcount(if_t ifp, u_int if_hw_tsomaxsegcount); 656 int if_sethwtsomaxsegsize(if_t ifp, u_int if_hw_tsomaxsegsize); 657 u_int if_gethwtsomax(const if_t ifp); 658 u_int if_gethwtsomaxsegcount(const if_t ifp); 659 u_int if_gethwtsomaxsegsize(const if_t ifp); 660 void if_setnetmapadapter(if_t ifp, struct netmap_adapter *na); 661 struct netmap_adapter *if_getnetmapadapter(if_t ifp); 662 void if_input(if_t ifp, struct mbuf* sendmp); 663 int if_sendq_prepend(if_t ifp, struct mbuf *m); 664 struct mbuf *if_dequeue(if_t ifp); 665 int if_setifheaderlen(if_t ifp, int len); 666 void if_setrcvif(struct mbuf *m, if_t ifp); 667 void if_setvtag(struct mbuf *m, u_int16_t tag); 668 u_int16_t if_getvtag(struct mbuf *m); 669 int if_vlantrunkinuse(if_t ifp); 670 char *if_getlladdr(const if_t ifp); 671 struct vnet *if_getvnet(const if_t ifp); 672 void *if_gethandle(u_char); 673 void if_vlancap(if_t ifp); 674 int if_transmit(if_t ifp, struct mbuf *m); 675 void if_init(if_t ifp, void *ctx); 676 int if_ioctl(if_t ifp, u_long cmd, void *data); 677 int if_resolvemulti(if_t ifp, struct sockaddr **, struct sockaddr *); 678 uint64_t if_getcounter(if_t ifp, ift_counter counter); 679 struct label *if_getmaclabel(if_t ifp); 680 void if_setmaclabel(if_t ifp, struct label *label); 681 struct bpf_if *if_getbpf(if_t ifp); 682 uint8_t if_getpcp(if_t ifp); 683 void *if_getl2com(if_t ifp); 684 struct ifvlantrunk *if_getvlantrunk(if_t ifp); 685 bool if_altq_is_enabled(if_t ifp); 686 687 struct in_ifinfo *if_getinet(if_t ifp); 688 struct in6_ifextra *if_getinet6(if_t ifp); 689 690 int if_snd_tag_alloc(if_t ifp, union if_snd_tag_alloc_params *params, 691 struct m_snd_tag **mstp); 692 /* 693 * Traversing through interface address lists. 694 */ 695 struct sockaddr_dl; 696 typedef u_int iflladdr_cb_t(void *, struct sockaddr_dl *, u_int); 697 u_int if_foreach_lladdr(if_t, iflladdr_cb_t, void *); 698 u_int if_foreach_llmaddr(if_t, iflladdr_cb_t, void *); 699 u_int if_lladdr_count(if_t); 700 u_int if_llmaddr_count(if_t); 701 bool if_maddr_empty(if_t); 702 703 struct ifaddr * if_getifaddr(const if_t ifp); 704 typedef u_int if_addr_cb_t(void *, struct ifaddr *, u_int); 705 u_int if_foreach_addr_type(if_t ifp, int type, if_addr_cb_t cb, void *cb_arg); 706 707 typedef int (*if_foreach_cb_t)(if_t, void *); 708 typedef bool (*if_foreach_match_t)(if_t, void *); 709 int if_foreach(if_foreach_cb_t, void *); 710 int if_foreach_sleep(if_foreach_match_t, void *, if_foreach_cb_t, void *); 711 712 /* Opaque iterator structure for iterating over interfaces. */ 713 struct if_iter { 714 void *context[4]; 715 }; 716 717 if_t if_iter_start(struct if_iter *); 718 if_t if_iter_next(struct if_iter *); 719 void if_iter_finish(struct if_iter *); 720 721 struct ifa_iter { 722 void *context[4]; 723 }; 724 725 struct ifaddr *ifa_iter_start(if_t ifp, struct ifa_iter *iter); 726 struct ifaddr *ifa_iter_next(struct ifa_iter *iter); 727 void ifa_iter_finish(struct ifa_iter *iter); 728 729 /* Functions */ 730 void if_setinitfn(if_t ifp, if_init_fn_t); 731 void if_setinputfn(if_t ifp, if_input_fn_t); 732 if_input_fn_t if_getinputfn(if_t ifp); 733 void if_setioctlfn(if_t ifp, if_ioctl_fn_t); 734 void if_setvfstatusfn(if_t ifp, if_vf_status_fn_t); 735 void if_setoutputfn(if_t ifp, if_output_fn_t); 736 void if_setstartfn(if_t ifp, if_start_fn_t); 737 if_start_fn_t if_getstartfn(if_t ifp); 738 void if_settransmitfn(if_t ifp, if_transmit_fn_t); 739 if_transmit_fn_t if_gettransmitfn(if_t ifp); 740 void if_setqflushfn(if_t ifp, if_qflush_fn_t); 741 if_qflush_fn_t if_getqflushfn(if_t ifp); 742 void if_setgetcounterfn(if_t ifp, if_get_counter_t); 743 void if_setsndtagallocfn(if_t ifp, if_snd_tag_alloc_t); 744 void if_setdebugnet_methods(if_t, struct debugnet_methods *); 745 void if_setreassignfn(if_t ifp, if_reassign_fn_t); 746 void if_setratelimitqueryfn(if_t ifp, if_ratelimit_query_t); 747 748 /* 749 * NB: The interface is not yet stable, drivers implementing IPSEC 750 * offload need to be prepared to adapt to changes. 751 */ 752 struct if_ipsec_accel_methods { 753 if_spdadd_fn_t if_spdadd; 754 if_spddel_fn_t if_spddel; 755 if_sa_newkey_fn_t if_sa_newkey; 756 if_sa_deinstall_fn_t if_sa_deinstall; 757 if_sa_cnt_fn_t if_sa_cnt; 758 if_ipsec_hwassist_fn_t if_hwassist; 759 }; 760 void if_setipsec_accel_methods(if_t ifp, const struct if_ipsec_accel_methods *); 761 762 /* TSO */ 763 void if_hw_tsomax_common(if_t ifp, struct ifnet_hw_tsomax *); 764 int if_hw_tsomax_update(if_t ifp, struct ifnet_hw_tsomax *); 765 766 /* accessors for struct ifreq */ 767 void *ifr_data_get_ptr(void *ifrp); 768 void *ifr_buffer_get_buffer(void *data); 769 size_t ifr_buffer_get_length(void *data); 770 771 int ifhwioctl(u_long, if_t, caddr_t, struct thread *); 772 int if_get_vf_status(if_t, struct if_vf_status **); 773 774 #ifdef DEVICE_POLLING 775 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS }; 776 777 typedef int poll_handler_t(if_t ifp, enum poll_cmd cmd, int count); 778 int ether_poll_register(poll_handler_t *h, if_t ifp); 779 int ether_poll_deregister(if_t ifp); 780 #endif /* DEVICE_POLLING */ 781 782 #endif /* _KERNEL */ 783 784 #include <net/ifq.h> /* XXXAO: temporary unconditional include */ 785 786 #endif /* !_NET_IF_VAR_H_ */ 787