if_var.h revision 330897
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 * 4. 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: stable/11/sys/net/if_var.h 330897 2018-03-14 03:19:51Z eadler $ 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 63struct rtentry; /* ifa_rtrequest */ 64struct rt_addrinfo; /* ifa_rtrequest */ 65struct socket; 66struct carp_if; 67struct carp_softc; 68struct ifvlantrunk; 69struct route; /* if_output */ 70struct vnet; 71struct ifmedia; 72struct 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 90TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */ 91TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */ 92TAILQ_HEAD(ifmultihead, ifmultiaddr); 93TAILQ_HEAD(ifgrouphead, ifg_group); 94 95#ifdef _KERNEL 96VNET_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 102VNET_DECLARE(struct hhook_head *, ipsec_hhh_in[HHOOK_IPSEC_COUNT]); 103VNET_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 108typedef 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 124typedef struct ifnet * if_t; 125 126typedef void (*if_start_fn_t)(if_t); 127typedef int (*if_ioctl_fn_t)(if_t, u_long, caddr_t); 128typedef void (*if_init_fn_t)(void *); 129typedef void (*if_qflush_fn_t)(if_t); 130typedef int (*if_transmit_fn_t)(if_t, struct mbuf *); 131typedef uint64_t (*if_get_counter_t)(if_t, ift_counter); 132 133struct 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 */ 140typedef 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 166struct 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/* 182 * Structure defining a network interface. 183 * 184 * Size ILP32: 592 (approx) 185 * LP64: 1048 (approx) 186 */ 187struct ifnet { 188 /* General book keeping of interface lists. */ 189 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */ 190 LIST_ENTRY(ifnet) if_clones; /* interfaces of a cloner */ 191 TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */ 192 /* protected by if_addr_lock */ 193 u_char if_alloctype; /* if_type at time of allocation */ 194 195 /* Driver and protocol specific information that remains stable. */ 196 void *if_softc; /* pointer to driver state */ 197 void *if_llsoftc; /* link layer softc */ 198 void *if_l2com; /* pointer to protocol bits */ 199 const char *if_dname; /* driver name */ 200 int if_dunit; /* unit or IF_DUNIT_NONE */ 201 u_short if_index; /* numeric abbreviation for this if */ 202 short if_index_reserved; /* spare space to grow if_index */ 203 char if_xname[IFNAMSIZ]; /* external name (name + unit) */ 204 char *if_description; /* interface description */ 205 206 /* Variable fields that are touched by the stack and drivers. */ 207 int if_flags; /* up/down, broadcast, etc. */ 208 int if_drv_flags; /* driver-managed status flags */ 209 int if_capabilities; /* interface features & capabilities */ 210 int if_capenable; /* enabled features & capabilities */ 211 void *if_linkmib; /* link-type-specific MIB data */ 212 size_t if_linkmiblen; /* length of above data */ 213 u_int if_refcount; /* reference count */ 214 215 /* These fields are shared with struct if_data. */ 216 uint8_t if_type; /* ethernet, tokenring, etc */ 217 uint8_t if_addrlen; /* media address length */ 218 uint8_t if_hdrlen; /* media header length */ 219 uint8_t if_link_state; /* current link state */ 220 uint32_t if_mtu; /* maximum transmission unit */ 221 uint32_t if_metric; /* routing metric (external only) */ 222 uint64_t if_baudrate; /* linespeed */ 223 uint64_t if_hwassist; /* HW offload capabilities, see IFCAP */ 224 time_t if_epoch; /* uptime at attach or stat reset */ 225 struct timeval if_lastchange; /* time of last administrative change */ 226 227 struct ifaltq if_snd; /* output queue (includes altq) */ 228 struct task if_linktask; /* task for link change events */ 229 230 /* Addresses of different protocol families assigned to this if. */ 231 struct rwlock if_addr_lock; /* lock to protect address lists */ 232 /* 233 * if_addrhead is the list of all addresses associated to 234 * an interface. 235 * Some code in the kernel assumes that first element 236 * of the list has type AF_LINK, and contains sockaddr_dl 237 * addresses which store the link-level address and the name 238 * of the interface. 239 * However, access to the AF_LINK address through this 240 * field is deprecated. Use if_addr or ifaddr_byindex() instead. 241 */ 242 struct ifaddrhead if_addrhead; /* linked list of addresses per if */ 243 struct ifmultihead if_multiaddrs; /* multicast addresses configured */ 244 int if_amcount; /* number of all-multicast requests */ 245 struct ifaddr *if_addr; /* pointer to link-level address */ 246 const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */ 247 struct rwlock if_afdata_lock; 248 void *if_afdata[AF_MAX]; 249 int if_afdata_initialized; 250 251 /* Additional features hung off the interface. */ 252 u_int if_fib; /* interface FIB */ 253 struct vnet *if_vnet; /* pointer to network stack instance */ 254 struct vnet *if_home_vnet; /* where this ifnet originates from */ 255 struct ifvlantrunk *if_vlantrunk; /* pointer to 802.1q data */ 256 struct bpf_if *if_bpf; /* packet filter structure */ 257 int if_pcount; /* number of promiscuous listeners */ 258 void *if_bridge; /* bridge glue */ 259 void *if_lagg; /* lagg glue */ 260 void *if_pf_kif; /* pf glue */ 261 struct carp_if *if_carp; /* carp interface structure */ 262 struct label *if_label; /* interface MAC label */ 263 struct netmap_adapter *if_netmap; /* netmap(4) softc */ 264 265 /* Various procedures of the layer2 encapsulation and drivers. */ 266 int (*if_output) /* output routine (enqueue) */ 267 (struct ifnet *, struct mbuf *, const struct sockaddr *, 268 struct route *); 269 void (*if_input) /* input routine (from h/w driver) */ 270 (struct ifnet *, struct mbuf *); 271 if_start_fn_t if_start; /* initiate output routine */ 272 if_ioctl_fn_t if_ioctl; /* ioctl routine */ 273 if_init_fn_t if_init; /* Init routine */ 274 int (*if_resolvemulti) /* validate/resolve multicast */ 275 (struct ifnet *, struct sockaddr **, struct sockaddr *); 276 if_qflush_fn_t if_qflush; /* flush any queue */ 277 if_transmit_fn_t if_transmit; /* initiate output routine */ 278 279 void (*if_reassign) /* reassign to vnet routine */ 280 (struct ifnet *, struct vnet *, char *); 281 if_get_counter_t if_get_counter; /* get counter values */ 282 int (*if_requestencap) /* make link header from request */ 283 (struct ifnet *, struct if_encap_req *); 284 285 /* Statistics. */ 286 counter_u64_t if_counters[IFCOUNTERS]; 287 288 /* Stuff that's only temporary and doesn't belong here. */ 289 290 /* 291 * Network adapter TSO limits: 292 * =========================== 293 * 294 * If the "if_hw_tsomax" field is zero the maximum segment 295 * length limit does not apply. If the "if_hw_tsomaxsegcount" 296 * or the "if_hw_tsomaxsegsize" field is zero the TSO segment 297 * count limit does not apply. If all three fields are zero, 298 * there is no TSO limit. 299 * 300 * NOTE: The TSO limits should reflect the values used in the 301 * BUSDMA tag a network adapter is using to load a mbuf chain 302 * for transmission. The TCP/IP network stack will subtract 303 * space for all linklevel and protocol level headers and 304 * ensure that the full mbuf chain passed to the network 305 * adapter fits within the given limits. 306 */ 307 u_int if_hw_tsomax; /* TSO maximum size in bytes */ 308 u_int if_hw_tsomaxsegcount; /* TSO maximum segment count */ 309 u_int if_hw_tsomaxsegsize; /* TSO maximum segment size in bytes */ 310 311 /* 312 * Spare fields to be added before branching a stable branch, so 313 * that structure can be enhanced without changing the kernel 314 * binary interface. 315 */ 316 void *if_pspare[3]; /* packet pacing / general use */ 317 void *if_hw_addr; /* hardware link-level address */ 318 int if_ispare[4]; /* packet pacing / general use */ 319}; 320 321/* for compatibility with other BSDs */ 322#define if_addrlist if_addrhead 323#define if_list if_link 324#define if_name(ifp) ((ifp)->if_xname) 325 326/* 327 * Locks for address lists on the network interface. 328 */ 329#define IF_ADDR_LOCK_INIT(if) rw_init(&(if)->if_addr_lock, "if_addr_lock") 330#define IF_ADDR_LOCK_DESTROY(if) rw_destroy(&(if)->if_addr_lock) 331#define IF_ADDR_WLOCK(if) rw_wlock(&(if)->if_addr_lock) 332#define IF_ADDR_WUNLOCK(if) rw_wunlock(&(if)->if_addr_lock) 333#define IF_ADDR_RLOCK(if) rw_rlock(&(if)->if_addr_lock) 334#define IF_ADDR_RUNLOCK(if) rw_runlock(&(if)->if_addr_lock) 335#define IF_ADDR_LOCK_ASSERT(if) rw_assert(&(if)->if_addr_lock, RA_LOCKED) 336#define IF_ADDR_WLOCK_ASSERT(if) rw_assert(&(if)->if_addr_lock, RA_WLOCKED) 337 338/* 339 * Function variations on locking macros intended to be used by loadable 340 * kernel modules in order to divorce them from the internals of address list 341 * locking. 342 */ 343void if_addr_rlock(struct ifnet *ifp); /* if_addrhead */ 344void if_addr_runlock(struct ifnet *ifp); /* if_addrhead */ 345void if_maddr_rlock(if_t ifp); /* if_multiaddrs */ 346void if_maddr_runlock(if_t ifp); /* if_multiaddrs */ 347 348#ifdef _KERNEL 349#ifdef _SYS_EVENTHANDLER_H_ 350/* interface link layer address change event */ 351typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *); 352EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t); 353/* interface address change event */ 354typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *); 355EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t); 356/* new interface arrival event */ 357typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *); 358EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t); 359/* interface departure event */ 360typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *); 361EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t); 362/* Interface link state change event */ 363typedef void (*ifnet_link_event_handler_t)(void *, struct ifnet *, int); 364EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t); 365/* Interface up/down event */ 366#define IFNET_EVENT_UP 0 367#define IFNET_EVENT_DOWN 1 368typedef void (*ifnet_event_fn)(void *, struct ifnet *ifp, int event); 369EVENTHANDLER_DECLARE(ifnet_event, ifnet_event_fn); 370#endif /* _SYS_EVENTHANDLER_H_ */ 371 372/* 373 * interface groups 374 */ 375struct ifg_group { 376 char ifg_group[IFNAMSIZ]; 377 u_int ifg_refcnt; 378 void *ifg_pf_kif; 379 TAILQ_HEAD(, ifg_member) ifg_members; 380 TAILQ_ENTRY(ifg_group) ifg_next; 381}; 382 383struct ifg_member { 384 TAILQ_ENTRY(ifg_member) ifgm_next; 385 struct ifnet *ifgm_ifp; 386}; 387 388struct ifg_list { 389 struct ifg_group *ifgl_group; 390 TAILQ_ENTRY(ifg_list) ifgl_next; 391}; 392 393#ifdef _SYS_EVENTHANDLER_H_ 394/* group attach event */ 395typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *); 396EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t); 397/* group detach event */ 398typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *); 399EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t); 400/* group change event */ 401typedef void (*group_change_event_handler_t)(void *, const char *); 402EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t); 403#endif /* _SYS_EVENTHANDLER_H_ */ 404 405#define IF_AFDATA_LOCK_INIT(ifp) \ 406 rw_init(&(ifp)->if_afdata_lock, "if_afdata") 407 408#define IF_AFDATA_WLOCK(ifp) rw_wlock(&(ifp)->if_afdata_lock) 409#define IF_AFDATA_RLOCK(ifp) rw_rlock(&(ifp)->if_afdata_lock) 410#define IF_AFDATA_WUNLOCK(ifp) rw_wunlock(&(ifp)->if_afdata_lock) 411#define IF_AFDATA_RUNLOCK(ifp) rw_runlock(&(ifp)->if_afdata_lock) 412#define IF_AFDATA_LOCK(ifp) IF_AFDATA_WLOCK(ifp) 413#define IF_AFDATA_UNLOCK(ifp) IF_AFDATA_WUNLOCK(ifp) 414#define IF_AFDATA_TRYLOCK(ifp) rw_try_wlock(&(ifp)->if_afdata_lock) 415#define IF_AFDATA_DESTROY(ifp) rw_destroy(&(ifp)->if_afdata_lock) 416 417#define IF_AFDATA_LOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_LOCKED) 418#define IF_AFDATA_RLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_RLOCKED) 419#define IF_AFDATA_WLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_WLOCKED) 420#define IF_AFDATA_UNLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_UNLOCKED) 421 422/* 423 * 72 was chosen below because it is the size of a TCP/IP 424 * header (40) + the minimum mss (32). 425 */ 426#define IF_MINMTU 72 427#define IF_MAXMTU 65535 428 429#define TOEDEV(ifp) ((ifp)->if_llsoftc) 430 431/* 432 * The ifaddr structure contains information about one address 433 * of an interface. They are maintained by the different address families, 434 * are allocated and attached when an address is set, and are linked 435 * together so all addresses for an interface can be located. 436 * 437 * NOTE: a 'struct ifaddr' is always at the beginning of a larger 438 * chunk of malloc'ed memory, where we store the three addresses 439 * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here. 440 */ 441struct ifaddr { 442 struct sockaddr *ifa_addr; /* address of interface */ 443 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 444#define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 445 struct sockaddr *ifa_netmask; /* used to determine subnet */ 446 struct ifnet *ifa_ifp; /* back-pointer to interface */ 447 struct carp_softc *ifa_carp; /* pointer to CARP data */ 448 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */ 449 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 450 (int, struct rtentry *, struct rt_addrinfo *); 451 u_short ifa_flags; /* mostly rt_flags for cloning */ 452#define IFA_ROUTE RTF_UP /* route installed */ 453#define IFA_RTSELF RTF_HOST /* loopback route to self installed */ 454 u_int ifa_refcnt; /* references to this structure */ 455 456 counter_u64_t ifa_ipackets; 457 counter_u64_t ifa_opackets; 458 counter_u64_t ifa_ibytes; 459 counter_u64_t ifa_obytes; 460}; 461 462/* For compatibility with other BSDs. SCTP uses it. */ 463#define ifa_list ifa_link 464 465struct ifaddr * ifa_alloc(size_t size, int flags); 466void ifa_free(struct ifaddr *ifa); 467void ifa_ref(struct ifaddr *ifa); 468 469/* 470 * Multicast address structure. This is analogous to the ifaddr 471 * structure except that it keeps track of multicast addresses. 472 */ 473struct ifmultiaddr { 474 TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */ 475 struct sockaddr *ifma_addr; /* address this membership is for */ 476 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */ 477 struct ifnet *ifma_ifp; /* back-pointer to interface */ 478 u_int ifma_refcount; /* reference count */ 479 void *ifma_protospec; /* protocol-specific state, if any */ 480 struct ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */ 481}; 482 483extern struct rwlock ifnet_rwlock; 484extern struct sx ifnet_sxlock; 485 486#define IFNET_WLOCK() do { \ 487 sx_xlock(&ifnet_sxlock); \ 488 rw_wlock(&ifnet_rwlock); \ 489} while (0) 490 491#define IFNET_WUNLOCK() do { \ 492 rw_wunlock(&ifnet_rwlock); \ 493 sx_xunlock(&ifnet_sxlock); \ 494} while (0) 495 496/* 497 * To assert the ifnet lock, you must know not only whether it's for read or 498 * write, but also whether it was acquired with sleep support or not. 499 */ 500#define IFNET_RLOCK_ASSERT() sx_assert(&ifnet_sxlock, SA_SLOCKED) 501#define IFNET_RLOCK_NOSLEEP_ASSERT() rw_assert(&ifnet_rwlock, RA_RLOCKED) 502#define IFNET_WLOCK_ASSERT() do { \ 503 sx_assert(&ifnet_sxlock, SA_XLOCKED); \ 504 rw_assert(&ifnet_rwlock, RA_WLOCKED); \ 505} while (0) 506 507#define IFNET_RLOCK() sx_slock(&ifnet_sxlock) 508#define IFNET_RLOCK_NOSLEEP() rw_rlock(&ifnet_rwlock) 509#define IFNET_RUNLOCK() sx_sunlock(&ifnet_sxlock) 510#define IFNET_RUNLOCK_NOSLEEP() rw_runlock(&ifnet_rwlock) 511 512/* 513 * Look up an ifnet given its index; the _ref variant also acquires a 514 * reference that must be freed using if_rele(). It is almost always a bug 515 * to call ifnet_byindex() instead if ifnet_byindex_ref(). 516 */ 517struct ifnet *ifnet_byindex(u_short idx); 518struct ifnet *ifnet_byindex_locked(u_short idx); 519struct ifnet *ifnet_byindex_ref(u_short idx); 520 521/* 522 * Given the index, ifaddr_byindex() returns the one and only 523 * link-level ifaddr for the interface. You are not supposed to use 524 * it to traverse the list of addresses associated to the interface. 525 */ 526struct ifaddr *ifaddr_byindex(u_short idx); 527 528VNET_DECLARE(struct ifnethead, ifnet); 529VNET_DECLARE(struct ifgrouphead, ifg_head); 530VNET_DECLARE(int, if_index); 531VNET_DECLARE(struct ifnet *, loif); /* first loopback interface */ 532 533#define V_ifnet VNET(ifnet) 534#define V_ifg_head VNET(ifg_head) 535#define V_if_index VNET(if_index) 536#define V_loif VNET(loif) 537 538int if_addgroup(struct ifnet *, const char *); 539int if_delgroup(struct ifnet *, const char *); 540int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **); 541int if_allmulti(struct ifnet *, int); 542struct ifnet* if_alloc(u_char); 543void if_attach(struct ifnet *); 544void if_dead(struct ifnet *); 545int if_delmulti(struct ifnet *, struct sockaddr *); 546void if_delmulti_ifma(struct ifmultiaddr *); 547void if_detach(struct ifnet *); 548void if_purgeaddrs(struct ifnet *); 549void if_delallmulti(struct ifnet *); 550void if_down(struct ifnet *); 551struct ifmultiaddr * 552 if_findmulti(struct ifnet *, const struct sockaddr *); 553void if_free(struct ifnet *); 554void if_initname(struct ifnet *, const char *, int); 555void if_link_state_change(struct ifnet *, int); 556int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3); 557void if_ref(struct ifnet *); 558void if_rele(struct ifnet *); 559int if_setlladdr(struct ifnet *, const u_char *, int); 560void if_up(struct ifnet *); 561int ifioctl(struct socket *, u_long, caddr_t, struct thread *); 562int ifpromisc(struct ifnet *, int); 563struct ifnet *ifunit(const char *); 564struct ifnet *ifunit_ref(const char *); 565 566int ifa_add_loopback_route(struct ifaddr *, struct sockaddr *); 567int ifa_del_loopback_route(struct ifaddr *, struct sockaddr *); 568int ifa_switch_loopback_route(struct ifaddr *, struct sockaddr *); 569 570struct ifaddr *ifa_ifwithaddr(const struct sockaddr *); 571int ifa_ifwithaddr_check(const struct sockaddr *); 572struct ifaddr *ifa_ifwithbroadaddr(const struct sockaddr *, int); 573struct ifaddr *ifa_ifwithdstaddr(const struct sockaddr *, int); 574struct ifaddr *ifa_ifwithnet(const struct sockaddr *, int, int); 575struct ifaddr *ifa_ifwithroute(int, const struct sockaddr *, struct sockaddr *, 576 u_int); 577struct ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *); 578int ifa_preferred(struct ifaddr *, struct ifaddr *); 579 580int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen); 581 582typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp); 583typedef void if_com_free_t(void *com, u_char type); 584void if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f); 585void if_deregister_com_alloc(u_char type); 586void if_data_copy(struct ifnet *, struct if_data *); 587uint64_t if_get_counter_default(struct ifnet *, ift_counter); 588void if_inc_counter(struct ifnet *, ift_counter, int64_t); 589 590#define IF_LLADDR(ifp) \ 591 LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr)) 592 593uint64_t if_setbaudrate(if_t ifp, uint64_t baudrate); 594uint64_t if_getbaudrate(if_t ifp); 595int if_setcapabilities(if_t ifp, int capabilities); 596int if_setcapabilitiesbit(if_t ifp, int setbit, int clearbit); 597int if_getcapabilities(if_t ifp); 598int if_togglecapenable(if_t ifp, int togglecap); 599int if_setcapenable(if_t ifp, int capenable); 600int if_setcapenablebit(if_t ifp, int setcap, int clearcap); 601int if_getcapenable(if_t ifp); 602const char *if_getdname(if_t ifp); 603int if_setdev(if_t ifp, void *dev); 604int if_setdrvflagbits(if_t ifp, int if_setflags, int clear_flags); 605int if_getdrvflags(if_t ifp); 606int if_setdrvflags(if_t ifp, int flags); 607int if_clearhwassist(if_t ifp); 608int if_sethwassistbits(if_t ifp, int toset, int toclear); 609int if_sethwassist(if_t ifp, int hwassist_bit); 610int if_gethwassist(if_t ifp); 611int if_setsoftc(if_t ifp, void *softc); 612void *if_getsoftc(if_t ifp); 613int if_setflags(if_t ifp, int flags); 614int if_gethwaddr(if_t ifp, struct ifreq *); 615int if_setmtu(if_t ifp, int mtu); 616int if_getmtu(if_t ifp); 617int if_getmtu_family(if_t ifp, int family); 618int if_setflagbits(if_t ifp, int set, int clear); 619int if_getflags(if_t ifp); 620int if_sendq_empty(if_t ifp); 621int if_setsendqready(if_t ifp); 622int if_setsendqlen(if_t ifp, int tx_desc_count); 623int if_input(if_t ifp, struct mbuf* sendmp); 624int if_sendq_prepend(if_t ifp, struct mbuf *m); 625struct mbuf *if_dequeue(if_t ifp); 626int if_setifheaderlen(if_t ifp, int len); 627void if_setrcvif(struct mbuf *m, if_t ifp); 628void if_setvtag(struct mbuf *m, u_int16_t tag); 629u_int16_t if_getvtag(struct mbuf *m); 630int if_vlantrunkinuse(if_t ifp); 631caddr_t if_getlladdr(if_t ifp); 632void *if_gethandle(u_char); 633void if_bpfmtap(if_t ifp, struct mbuf *m); 634void if_etherbpfmtap(if_t ifp, struct mbuf *m); 635void if_vlancap(if_t ifp); 636 637int if_setupmultiaddr(if_t ifp, void *mta, int *cnt, int max); 638int if_multiaddr_array(if_t ifp, void *mta, int *cnt, int max); 639int if_multiaddr_count(if_t ifp, int max); 640 641int if_multi_apply(struct ifnet *ifp, int (*filter)(void *, struct ifmultiaddr *, int), void *arg); 642int if_getamcount(if_t ifp); 643struct ifaddr * if_getifaddr(if_t ifp); 644 645/* Functions */ 646void if_setinitfn(if_t ifp, void (*)(void *)); 647void if_setioctlfn(if_t ifp, int (*)(if_t, u_long, caddr_t)); 648void if_setstartfn(if_t ifp, void (*)(if_t)); 649void if_settransmitfn(if_t ifp, if_transmit_fn_t); 650void if_setqflushfn(if_t ifp, if_qflush_fn_t); 651void if_setgetcounterfn(if_t ifp, if_get_counter_t); 652 653/* Revisit the below. These are inline functions originally */ 654int drbr_inuse_drv(if_t ifp, struct buf_ring *br); 655struct mbuf* drbr_dequeue_drv(if_t ifp, struct buf_ring *br); 656int drbr_needs_enqueue_drv(if_t ifp, struct buf_ring *br); 657int drbr_enqueue_drv(if_t ifp, struct buf_ring *br, struct mbuf *m); 658 659/* TSO */ 660void if_hw_tsomax_common(if_t ifp, struct ifnet_hw_tsomax *); 661int if_hw_tsomax_update(if_t ifp, struct ifnet_hw_tsomax *); 662 663#ifdef DEVICE_POLLING 664enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS }; 665 666typedef int poll_handler_t(if_t ifp, enum poll_cmd cmd, int count); 667int ether_poll_register(poll_handler_t *h, if_t ifp); 668int ether_poll_deregister(if_t ifp); 669#endif /* DEVICE_POLLING */ 670 671#endif /* _KERNEL */ 672 673#include <net/ifq.h> /* XXXAO: temporary unconditional include */ 674 675#endif /* !_NET_IF_VAR_H_ */ 676