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