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