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/10/sys/net/if_var.h 318505 2017-05-18 23:41:34Z rpokala $ 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 61#ifdef __STDC__ 62/* 63 * Forward structure declarations for function prototypes [sic]. 64 */ 65struct mbuf; 66struct thread; 67struct rtentry; 68struct rt_addrinfo; 69struct socket; 70struct ether_header; 71struct carp_if; 72struct carp_softc; 73struct ifvlantrunk; 74struct route; 75struct vnet; 76#endif 77 78#include <sys/queue.h> /* get TAILQ macros */ 79 80#ifdef _KERNEL 81#include <sys/mbuf.h> 82#include <sys/eventhandler.h> 83#include <sys/buf_ring.h> 84#include <net/vnet.h> 85#endif /* _KERNEL */ 86#include <sys/lock.h> /* XXX */ 87#include <sys/mutex.h> /* XXX */ 88#include <sys/rwlock.h> /* XXX */ 89#include <sys/sx.h> /* XXX */ 90#include <sys/event.h> /* XXX */ 91#include <sys/_task.h> 92 93#define IF_DUNIT_NONE -1 94 95#include <altq/if_altq.h> 96 97TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */ 98TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */ 99TAILQ_HEAD(ifmultihead, ifmultiaddr); 100TAILQ_HEAD(ifgrouphead, ifg_group); 101 102#ifdef _KERNEL 103VNET_DECLARE(struct pfil_head, link_pfil_hook); /* packet filter hooks */ 104#define V_link_pfil_hook VNET(link_pfil_hook) 105#endif /* _KERNEL */ 106 107typedef enum { 108 IFCOUNTER_IPACKETS = 0, 109 IFCOUNTER_IERRORS, 110 IFCOUNTER_OPACKETS, 111 IFCOUNTER_OERRORS, 112 IFCOUNTER_COLLISIONS, 113 IFCOUNTER_IBYTES, 114 IFCOUNTER_OBYTES, 115 IFCOUNTER_IMCASTS, 116 IFCOUNTER_OMCASTS, 117 IFCOUNTER_IQDROPS, 118 IFCOUNTER_OQDROPS, 119 IFCOUNTER_NOPROTO, 120 IFCOUNTERS /* Array size. */ 121} ift_counter; 122 123/* 124 * Structure defining a queue for a network interface. 125 */ 126struct ifqueue { 127 struct mbuf *ifq_head; 128 struct mbuf *ifq_tail; 129 int ifq_len; 130 int ifq_maxlen; 131 int ifq_drops; 132 struct mtx ifq_mtx; 133}; 134 135struct ifnet_hw_tsomax { 136 u_int tsomaxbytes; /* TSO total burst length limit in bytes */ 137 u_int tsomaxsegcount; /* TSO maximum segment count */ 138 u_int tsomaxsegsize; /* TSO maximum segment size in bytes */ 139}; 140 141/* 142 * Structure defining a network interface. 143 * 144 * (Would like to call this struct ``if'', but C isn't PL/1.) 145 */ 146 147struct ifnet { 148 void *if_softc; /* pointer to driver state */ 149 void *if_l2com; /* pointer to protocol bits */ 150 struct vnet *if_vnet; /* pointer to network stack instance */ 151 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */ 152 char if_xname[IFNAMSIZ]; /* external name (name + unit) */ 153 const char *if_dname; /* driver name */ 154 int if_dunit; /* unit or IF_DUNIT_NONE */ 155 u_int if_refcount; /* reference count */ 156 struct ifaddrhead if_addrhead; /* linked list of addresses per if */ 157 /* 158 * if_addrhead is the list of all addresses associated to 159 * an interface. 160 * Some code in the kernel assumes that first element 161 * of the list has type AF_LINK, and contains sockaddr_dl 162 * addresses which store the link-level address and the name 163 * of the interface. 164 * However, access to the AF_LINK address through this 165 * field is deprecated. Use if_addr or ifaddr_byindex() instead. 166 */ 167 int if_pcount; /* number of promiscuous listeners */ 168 struct carp_if *if_carp; /* carp interface structure */ 169 struct bpf_if *if_bpf; /* packet filter structure */ 170 u_short if_index; /* numeric abbreviation for this if */ 171 short if_index_reserved; /* spare space to grow if_index */ 172 struct ifvlantrunk *if_vlantrunk; /* pointer to 802.1q data */ 173 int if_flags; /* up/down, broadcast, etc. */ 174 int if_capabilities; /* interface features & capabilities */ 175 int if_capenable; /* enabled features & capabilities */ 176 void *if_linkmib; /* link-type-specific MIB data */ 177 size_t if_linkmiblen; /* length of above data */ 178 struct if_data if_data; 179 struct ifmultihead if_multiaddrs; /* multicast addresses configured */ 180 int if_amcount; /* number of all-multicast requests */ 181/* procedure handles */ 182 int (*if_output) /* output routine (enqueue) */ 183 (struct ifnet *, struct mbuf *, const struct sockaddr *, 184 struct route *); 185 void (*if_input) /* input routine (from h/w driver) */ 186 (struct ifnet *, struct mbuf *); 187 void (*if_start) /* initiate output routine */ 188 (struct ifnet *); 189 int (*if_ioctl) /* ioctl routine */ 190 (struct ifnet *, u_long, caddr_t); 191 void (*if_init) /* Init routine */ 192 (void *); 193 int (*if_resolvemulti) /* validate/resolve multicast */ 194 (struct ifnet *, struct sockaddr **, struct sockaddr *); 195 void (*if_qflush) /* flush any queues */ 196 (struct ifnet *); 197 int (*if_transmit) /* initiate output routine */ 198 (struct ifnet *, struct mbuf *); 199 void (*if_reassign) /* reassign to vnet routine */ 200 (struct ifnet *, struct vnet *, char *); 201 struct vnet *if_home_vnet; /* where this ifnet originates from */ 202 struct ifaddr *if_addr; /* pointer to link-level address */ 203 void *if_llsoftc; /* link layer softc */ 204 int if_drv_flags; /* driver-managed status flags */ 205 struct ifaltq if_snd; /* output queue (includes altq) */ 206 const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */ 207 208 void *if_bridge; /* bridge glue */ 209 210 struct label *if_label; /* interface MAC label */ 211 212 /* these are only used by IPv6 */ 213 void *if_unused[2]; 214 void *if_afdata[AF_MAX]; 215 int if_afdata_initialized; 216 struct rwlock if_afdata_lock; 217 struct task if_linktask; /* task for link change events */ 218 struct rwlock if_addr_lock; /* lock to protect address lists */ 219 220 LIST_ENTRY(ifnet) if_clones; /* interfaces of a cloner */ 221 TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */ 222 /* protected by if_addr_lock */ 223 void *if_pf_kif; 224 void *if_lagg; /* lagg glue */ 225 char *if_description; /* interface description */ 226 u_int if_fib; /* interface FIB */ 227 u_char if_alloctype; /* if_type at time of allocation */ 228 229 /* 230 * Network adapter TSO limits: 231 * =========================== 232 * 233 * If the "if_hw_tsomax" field is zero the maximum segment 234 * length limit does not apply. If the "if_hw_tsomaxsegcount" 235 * or the "if_hw_tsomaxsegsize" field is zero the TSO segment 236 * count limit does not apply. If all three fields are zero, 237 * there is no TSO limit. 238 * 239 * NOTE: The TSO limits should reflect the values used in the 240 * BUSDMA tag a network adapter is using to load a mbuf chain 241 * for transmission. The TCP/IP network stack will subtract 242 * space for all linklevel and protocol level headers and 243 * ensure that the full mbuf chain passed to the network 244 * adapter fits within the given limits. 245 */ 246 u_int if_hw_tsomax; 247 248 /* 249 * Spare fields are added so that we can modify sensitive data 250 * structures without changing the kernel binary interface, and must 251 * be used with care where binary compatibility is required. 252 */ 253 char if_cspare[3]; 254 int if_ispare[2]; 255 256 /* 257 * TSO fields for segment limits. If a field is zero below, 258 * there is no limit: 259 */ 260 u_int if_hw_tsomaxsegcount; /* TSO maximum segment count */ 261 u_int if_hw_tsomaxsegsize; /* TSO maximum segment size in bytes */ 262 void *if_pspare[7]; /* 1 netmap, 6 TDB */ 263 void *if_hw_addr; /* hardware link-level address */ 264}; 265 266typedef void if_init_f_t(void *); 267 268/* 269 * XXX These aliases are terribly dangerous because they could apply 270 * to anything. 271 */ 272#define if_mtu if_data.ifi_mtu 273#define if_type if_data.ifi_type 274#define if_physical if_data.ifi_physical 275#define if_addrlen if_data.ifi_addrlen 276#define if_hdrlen if_data.ifi_hdrlen 277#define if_metric if_data.ifi_metric 278#define if_link_state if_data.ifi_link_state 279#define if_baudrate if_data.ifi_baudrate 280#define if_baudrate_pf if_data.ifi_baudrate_pf 281#define if_hwassist if_data.ifi_hwassist 282#define if_ipackets if_data.ifi_ipackets 283#define if_ierrors if_data.ifi_ierrors 284#define if_opackets if_data.ifi_opackets 285#define if_oerrors if_data.ifi_oerrors 286#define if_collisions if_data.ifi_collisions 287#define if_ibytes if_data.ifi_ibytes 288#define if_obytes if_data.ifi_obytes 289#define if_imcasts if_data.ifi_imcasts 290#define if_omcasts if_data.ifi_omcasts 291#define if_iqdrops if_data.ifi_iqdrops 292#define if_noproto if_data.ifi_noproto 293#define if_lastchange if_data.ifi_lastchange 294 295/* for compatibility with other BSDs */ 296#define if_addrlist if_addrhead 297#define if_list if_link 298#define if_name(ifp) ((ifp)->if_xname) 299 300/* 301 * Locks for address lists on the network interface. 302 */ 303#define IF_ADDR_LOCK_INIT(if) rw_init(&(if)->if_addr_lock, "if_addr_lock") 304#define IF_ADDR_LOCK_DESTROY(if) rw_destroy(&(if)->if_addr_lock) 305#define IF_ADDR_WLOCK(if) rw_wlock(&(if)->if_addr_lock) 306#define IF_ADDR_WUNLOCK(if) rw_wunlock(&(if)->if_addr_lock) 307#define IF_ADDR_RLOCK(if) rw_rlock(&(if)->if_addr_lock) 308#define IF_ADDR_RUNLOCK(if) rw_runlock(&(if)->if_addr_lock) 309#define IF_ADDR_LOCK_ASSERT(if) rw_assert(&(if)->if_addr_lock, RA_LOCKED) 310#define IF_ADDR_WLOCK_ASSERT(if) rw_assert(&(if)->if_addr_lock, RA_WLOCKED) 311 312/* 313 * Function variations on locking macros intended to be used by loadable 314 * kernel modules in order to divorce them from the internals of address list 315 * locking. 316 */ 317void if_addr_rlock(struct ifnet *ifp); /* if_addrhead */ 318void if_addr_runlock(struct ifnet *ifp); /* if_addrhead */ 319void if_maddr_rlock(struct ifnet *ifp); /* if_multiaddrs */ 320void if_maddr_runlock(struct ifnet *ifp); /* if_multiaddrs */ 321 322/* 323 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq) 324 * are queues of messages stored on ifqueue structures 325 * (defined above). Entries are added to and deleted from these structures 326 * by these macros. 327 */ 328#define IF_LOCK(ifq) mtx_lock(&(ifq)->ifq_mtx) 329#define IF_UNLOCK(ifq) mtx_unlock(&(ifq)->ifq_mtx) 330#define IF_LOCK_ASSERT(ifq) mtx_assert(&(ifq)->ifq_mtx, MA_OWNED) 331#define _IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 332#define _IF_DROP(ifq) ((ifq)->ifq_drops++) 333#define _IF_QLEN(ifq) ((ifq)->ifq_len) 334 335#define _IF_ENQUEUE(ifq, m) do { \ 336 (m)->m_nextpkt = NULL; \ 337 if ((ifq)->ifq_tail == NULL) \ 338 (ifq)->ifq_head = m; \ 339 else \ 340 (ifq)->ifq_tail->m_nextpkt = m; \ 341 (ifq)->ifq_tail = m; \ 342 (ifq)->ifq_len++; \ 343} while (0) 344 345#define IF_ENQUEUE(ifq, m) do { \ 346 IF_LOCK(ifq); \ 347 _IF_ENQUEUE(ifq, m); \ 348 IF_UNLOCK(ifq); \ 349} while (0) 350 351#define _IF_PREPEND(ifq, m) do { \ 352 (m)->m_nextpkt = (ifq)->ifq_head; \ 353 if ((ifq)->ifq_tail == NULL) \ 354 (ifq)->ifq_tail = (m); \ 355 (ifq)->ifq_head = (m); \ 356 (ifq)->ifq_len++; \ 357} while (0) 358 359#define IF_PREPEND(ifq, m) do { \ 360 IF_LOCK(ifq); \ 361 _IF_PREPEND(ifq, m); \ 362 IF_UNLOCK(ifq); \ 363} while (0) 364 365#define _IF_DEQUEUE(ifq, m) do { \ 366 (m) = (ifq)->ifq_head; \ 367 if (m) { \ 368 if (((ifq)->ifq_head = (m)->m_nextpkt) == NULL) \ 369 (ifq)->ifq_tail = NULL; \ 370 (m)->m_nextpkt = NULL; \ 371 (ifq)->ifq_len--; \ 372 } \ 373} while (0) 374 375#define IF_DEQUEUE(ifq, m) do { \ 376 IF_LOCK(ifq); \ 377 _IF_DEQUEUE(ifq, m); \ 378 IF_UNLOCK(ifq); \ 379} while (0) 380 381#define _IF_DEQUEUE_ALL(ifq, m) do { \ 382 (m) = (ifq)->ifq_head; \ 383 (ifq)->ifq_head = (ifq)->ifq_tail = NULL; \ 384 (ifq)->ifq_len = 0; \ 385} while (0) 386 387#define IF_DEQUEUE_ALL(ifq, m) do { \ 388 IF_LOCK(ifq); \ 389 _IF_DEQUEUE_ALL(ifq, m); \ 390 IF_UNLOCK(ifq); \ 391} while (0) 392 393#define _IF_POLL(ifq, m) ((m) = (ifq)->ifq_head) 394#define IF_POLL(ifq, m) _IF_POLL(ifq, m) 395 396#define _IF_DRAIN(ifq) do { \ 397 struct mbuf *m; \ 398 for (;;) { \ 399 _IF_DEQUEUE(ifq, m); \ 400 if (m == NULL) \ 401 break; \ 402 m_freem(m); \ 403 } \ 404} while (0) 405 406#define IF_DRAIN(ifq) do { \ 407 IF_LOCK(ifq); \ 408 _IF_DRAIN(ifq); \ 409 IF_UNLOCK(ifq); \ 410} while(0) 411 412#ifdef _KERNEL 413/* interface link layer address change event */ 414typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *); 415EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t); 416/* interface address change event */ 417typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *); 418EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t); 419/* new interface arrival event */ 420typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *); 421EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t); 422/* interface departure event */ 423typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *); 424EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t); 425/* Interface link state change event */ 426typedef void (*ifnet_link_event_handler_t)(void *, struct ifnet *, int); 427EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t); 428/* Interface up/down event */ 429#define IFNET_EVENT_UP 0 430#define IFNET_EVENT_DOWN 1 431typedef void (*ifnet_event_fn)(void *, struct ifnet *ifp, int event); 432EVENTHANDLER_DECLARE(ifnet_event, ifnet_event_fn); 433 434/* 435 * interface groups 436 */ 437struct ifg_group { 438 char ifg_group[IFNAMSIZ]; 439 u_int ifg_refcnt; 440 void *ifg_pf_kif; 441 TAILQ_HEAD(, ifg_member) ifg_members; 442 TAILQ_ENTRY(ifg_group) ifg_next; 443}; 444 445struct ifg_member { 446 TAILQ_ENTRY(ifg_member) ifgm_next; 447 struct ifnet *ifgm_ifp; 448}; 449 450struct ifg_list { 451 struct ifg_group *ifgl_group; 452 TAILQ_ENTRY(ifg_list) ifgl_next; 453}; 454 455/* group attach event */ 456typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *); 457EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t); 458/* group detach event */ 459typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *); 460EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t); 461/* group change event */ 462typedef void (*group_change_event_handler_t)(void *, const char *); 463EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t); 464 465#define IF_AFDATA_LOCK_INIT(ifp) \ 466 rw_init(&(ifp)->if_afdata_lock, "if_afdata") 467 468#define IF_AFDATA_WLOCK(ifp) rw_wlock(&(ifp)->if_afdata_lock) 469#define IF_AFDATA_RLOCK(ifp) rw_rlock(&(ifp)->if_afdata_lock) 470#define IF_AFDATA_WUNLOCK(ifp) rw_wunlock(&(ifp)->if_afdata_lock) 471#define IF_AFDATA_RUNLOCK(ifp) rw_runlock(&(ifp)->if_afdata_lock) 472#define IF_AFDATA_LOCK(ifp) IF_AFDATA_WLOCK(ifp) 473#define IF_AFDATA_UNLOCK(ifp) IF_AFDATA_WUNLOCK(ifp) 474#define IF_AFDATA_TRYLOCK(ifp) rw_try_wlock(&(ifp)->if_afdata_lock) 475#define IF_AFDATA_DESTROY(ifp) rw_destroy(&(ifp)->if_afdata_lock) 476 477#define IF_AFDATA_LOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_LOCKED) 478#define IF_AFDATA_RLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_RLOCKED) 479#define IF_AFDATA_WLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_WLOCKED) 480#define IF_AFDATA_UNLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_UNLOCKED) 481 482int if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp, 483 int adjust); 484#define IF_HANDOFF(ifq, m, ifp) \ 485 if_handoff((struct ifqueue *)ifq, m, ifp, 0) 486#define IF_HANDOFF_ADJ(ifq, m, ifp, adj) \ 487 if_handoff((struct ifqueue *)ifq, m, ifp, adj) 488 489void if_start(struct ifnet *); 490 491#define IFQ_ENQUEUE(ifq, m, err) \ 492do { \ 493 IF_LOCK(ifq); \ 494 if (ALTQ_IS_ENABLED(ifq)) \ 495 ALTQ_ENQUEUE(ifq, m, NULL, err); \ 496 else { \ 497 if (_IF_QFULL(ifq)) { \ 498 m_freem(m); \ 499 (err) = ENOBUFS; \ 500 } else { \ 501 _IF_ENQUEUE(ifq, m); \ 502 (err) = 0; \ 503 } \ 504 } \ 505 if (err) \ 506 (ifq)->ifq_drops++; \ 507 IF_UNLOCK(ifq); \ 508} while (0) 509 510#define IFQ_DEQUEUE_NOLOCK(ifq, m) \ 511do { \ 512 if (TBR_IS_ENABLED(ifq)) \ 513 (m) = tbr_dequeue_ptr(ifq, ALTDQ_REMOVE); \ 514 else if (ALTQ_IS_ENABLED(ifq)) \ 515 ALTQ_DEQUEUE(ifq, m); \ 516 else \ 517 _IF_DEQUEUE(ifq, m); \ 518} while (0) 519 520#define IFQ_DEQUEUE(ifq, m) \ 521do { \ 522 IF_LOCK(ifq); \ 523 IFQ_DEQUEUE_NOLOCK(ifq, m); \ 524 IF_UNLOCK(ifq); \ 525} while (0) 526 527#define IFQ_POLL_NOLOCK(ifq, m) \ 528do { \ 529 if (TBR_IS_ENABLED(ifq)) \ 530 (m) = tbr_dequeue_ptr(ifq, ALTDQ_POLL); \ 531 else if (ALTQ_IS_ENABLED(ifq)) \ 532 ALTQ_POLL(ifq, m); \ 533 else \ 534 _IF_POLL(ifq, m); \ 535} while (0) 536 537#define IFQ_POLL(ifq, m) \ 538do { \ 539 IF_LOCK(ifq); \ 540 IFQ_POLL_NOLOCK(ifq, m); \ 541 IF_UNLOCK(ifq); \ 542} while (0) 543 544#define IFQ_PURGE_NOLOCK(ifq) \ 545do { \ 546 if (ALTQ_IS_ENABLED(ifq)) { \ 547 ALTQ_PURGE(ifq); \ 548 } else \ 549 _IF_DRAIN(ifq); \ 550} while (0) 551 552#define IFQ_PURGE(ifq) \ 553do { \ 554 IF_LOCK(ifq); \ 555 IFQ_PURGE_NOLOCK(ifq); \ 556 IF_UNLOCK(ifq); \ 557} while (0) 558 559#define IFQ_SET_READY(ifq) \ 560 do { ((ifq)->altq_flags |= ALTQF_READY); } while (0) 561 562#define IFQ_LOCK(ifq) IF_LOCK(ifq) 563#define IFQ_UNLOCK(ifq) IF_UNLOCK(ifq) 564#define IFQ_LOCK_ASSERT(ifq) IF_LOCK_ASSERT(ifq) 565#define IFQ_IS_EMPTY(ifq) ((ifq)->ifq_len == 0) 566#define IFQ_INC_LEN(ifq) ((ifq)->ifq_len++) 567#define IFQ_DEC_LEN(ifq) (--(ifq)->ifq_len) 568#define IFQ_INC_DROPS(ifq) ((ifq)->ifq_drops++) 569#define IFQ_SET_MAXLEN(ifq, len) ((ifq)->ifq_maxlen = (len)) 570 571/* 572 * The IFF_DRV_OACTIVE test should really occur in the device driver, not in 573 * the handoff logic, as that flag is locked by the device driver. 574 */ 575#define IFQ_HANDOFF_ADJ(ifp, m, adj, err) \ 576do { \ 577 int len; \ 578 short mflags; \ 579 \ 580 len = (m)->m_pkthdr.len; \ 581 mflags = (m)->m_flags; \ 582 IFQ_ENQUEUE(&(ifp)->if_snd, m, err); \ 583 if ((err) == 0) { \ 584 (ifp)->if_obytes += len + (adj); \ 585 if (mflags & M_MCAST) \ 586 (ifp)->if_omcasts++; \ 587 if (((ifp)->if_drv_flags & IFF_DRV_OACTIVE) == 0) \ 588 if_start(ifp); \ 589 } \ 590} while (0) 591 592#define IFQ_HANDOFF(ifp, m, err) \ 593 IFQ_HANDOFF_ADJ(ifp, m, 0, err) 594 595#define IFQ_DRV_DEQUEUE(ifq, m) \ 596do { \ 597 (m) = (ifq)->ifq_drv_head; \ 598 if (m) { \ 599 if (((ifq)->ifq_drv_head = (m)->m_nextpkt) == NULL) \ 600 (ifq)->ifq_drv_tail = NULL; \ 601 (m)->m_nextpkt = NULL; \ 602 (ifq)->ifq_drv_len--; \ 603 } else { \ 604 IFQ_LOCK(ifq); \ 605 IFQ_DEQUEUE_NOLOCK(ifq, m); \ 606 while ((ifq)->ifq_drv_len < (ifq)->ifq_drv_maxlen) { \ 607 struct mbuf *m0; \ 608 IFQ_DEQUEUE_NOLOCK(ifq, m0); \ 609 if (m0 == NULL) \ 610 break; \ 611 m0->m_nextpkt = NULL; \ 612 if ((ifq)->ifq_drv_tail == NULL) \ 613 (ifq)->ifq_drv_head = m0; \ 614 else \ 615 (ifq)->ifq_drv_tail->m_nextpkt = m0; \ 616 (ifq)->ifq_drv_tail = m0; \ 617 (ifq)->ifq_drv_len++; \ 618 } \ 619 IFQ_UNLOCK(ifq); \ 620 } \ 621} while (0) 622 623#define IFQ_DRV_PREPEND(ifq, m) \ 624do { \ 625 (m)->m_nextpkt = (ifq)->ifq_drv_head; \ 626 if ((ifq)->ifq_drv_tail == NULL) \ 627 (ifq)->ifq_drv_tail = (m); \ 628 (ifq)->ifq_drv_head = (m); \ 629 (ifq)->ifq_drv_len++; \ 630} while (0) 631 632#define IFQ_DRV_IS_EMPTY(ifq) \ 633 (((ifq)->ifq_drv_len == 0) && ((ifq)->ifq_len == 0)) 634 635#define IFQ_DRV_PURGE(ifq) \ 636do { \ 637 struct mbuf *m, *n = (ifq)->ifq_drv_head; \ 638 while((m = n) != NULL) { \ 639 n = m->m_nextpkt; \ 640 m_freem(m); \ 641 } \ 642 (ifq)->ifq_drv_head = (ifq)->ifq_drv_tail = NULL; \ 643 (ifq)->ifq_drv_len = 0; \ 644 IFQ_PURGE(ifq); \ 645} while (0) 646 647#ifdef _KERNEL 648static __inline void 649if_initbaudrate(struct ifnet *ifp, uintmax_t baud) 650{ 651 652 ifp->if_baudrate_pf = 0; 653 while (baud > (u_long)(~0UL)) { 654 baud /= 10; 655 ifp->if_baudrate_pf++; 656 } 657 ifp->if_baudrate = baud; 658} 659 660static __inline int 661drbr_enqueue(struct ifnet *ifp, struct buf_ring *br, struct mbuf *m) 662{ 663 int error = 0; 664 665#ifdef ALTQ 666 if (ALTQ_IS_ENABLED(&ifp->if_snd)) { 667 IFQ_ENQUEUE(&ifp->if_snd, m, error); 668 return (error); 669 } 670#endif 671 error = buf_ring_enqueue(br, m); 672 if (error) 673 m_freem(m); 674 675 return (error); 676} 677 678static __inline void 679drbr_putback(struct ifnet *ifp, struct buf_ring *br, struct mbuf *new) 680{ 681 /* 682 * The top of the list needs to be swapped 683 * for this one. 684 */ 685#ifdef ALTQ 686 if (ifp != NULL && ALTQ_IS_ENABLED(&ifp->if_snd)) { 687 /* 688 * Peek in altq case dequeued it 689 * so put it back. 690 */ 691 IFQ_DRV_PREPEND(&ifp->if_snd, new); 692 return; 693 } 694#endif 695 buf_ring_putback_sc(br, new); 696} 697 698static __inline struct mbuf * 699drbr_peek(struct ifnet *ifp, struct buf_ring *br) 700{ 701#ifdef ALTQ 702 struct mbuf *m; 703 if (ifp != NULL && ALTQ_IS_ENABLED(&ifp->if_snd)) { 704 /* 705 * Pull it off like a dequeue 706 * since drbr_advance() does nothing 707 * for altq and drbr_putback() will 708 * use the old prepend function. 709 */ 710 IFQ_DEQUEUE(&ifp->if_snd, m); 711 return (m); 712 } 713#endif 714 return(buf_ring_peek_clear_sc(br)); 715} 716 717static __inline void 718drbr_flush(struct ifnet *ifp, struct buf_ring *br) 719{ 720 struct mbuf *m; 721 722#ifdef ALTQ 723 if (ifp != NULL && ALTQ_IS_ENABLED(&ifp->if_snd)) 724 IFQ_PURGE(&ifp->if_snd); 725#endif 726 while ((m = buf_ring_dequeue_sc(br)) != NULL) 727 m_freem(m); 728} 729 730static __inline void 731drbr_free(struct buf_ring *br, struct malloc_type *type) 732{ 733 734 drbr_flush(NULL, br); 735 buf_ring_free(br, type); 736} 737 738static __inline struct mbuf * 739drbr_dequeue(struct ifnet *ifp, struct buf_ring *br) 740{ 741#ifdef ALTQ 742 struct mbuf *m; 743 744 if (ifp != NULL && ALTQ_IS_ENABLED(&ifp->if_snd)) { 745 IFQ_DEQUEUE(&ifp->if_snd, m); 746 return (m); 747 } 748#endif 749 return (buf_ring_dequeue_sc(br)); 750} 751 752static __inline void 753drbr_advance(struct ifnet *ifp, struct buf_ring *br) 754{ 755#ifdef ALTQ 756 /* Nothing to do here since peek dequeues in altq case */ 757 if (ifp != NULL && ALTQ_IS_ENABLED(&ifp->if_snd)) 758 return; 759#endif 760 return (buf_ring_advance_sc(br)); 761} 762 763 764static __inline struct mbuf * 765drbr_dequeue_cond(struct ifnet *ifp, struct buf_ring *br, 766 int (*func) (struct mbuf *, void *), void *arg) 767{ 768 struct mbuf *m; 769#ifdef ALTQ 770 if (ALTQ_IS_ENABLED(&ifp->if_snd)) { 771 IFQ_LOCK(&ifp->if_snd); 772 IFQ_POLL_NOLOCK(&ifp->if_snd, m); 773 if (m != NULL && func(m, arg) == 0) { 774 IFQ_UNLOCK(&ifp->if_snd); 775 return (NULL); 776 } 777 IFQ_DEQUEUE_NOLOCK(&ifp->if_snd, m); 778 IFQ_UNLOCK(&ifp->if_snd); 779 return (m); 780 } 781#endif 782 m = buf_ring_peek(br); 783 if (m == NULL || func(m, arg) == 0) 784 return (NULL); 785 786 return (buf_ring_dequeue_sc(br)); 787} 788 789static __inline int 790drbr_empty(struct ifnet *ifp, struct buf_ring *br) 791{ 792#ifdef ALTQ 793 if (ALTQ_IS_ENABLED(&ifp->if_snd)) 794 return (IFQ_IS_EMPTY(&ifp->if_snd)); 795#endif 796 return (buf_ring_empty(br)); 797} 798 799static __inline int 800drbr_needs_enqueue(struct ifnet *ifp, struct buf_ring *br) 801{ 802#ifdef ALTQ 803 if (ALTQ_IS_ENABLED(&ifp->if_snd)) 804 return (1); 805#endif 806 return (!buf_ring_empty(br)); 807} 808 809static __inline int 810drbr_inuse(struct ifnet *ifp, struct buf_ring *br) 811{ 812#ifdef ALTQ 813 if (ALTQ_IS_ENABLED(&ifp->if_snd)) 814 return (ifp->if_snd.ifq_len); 815#endif 816 return (buf_ring_count(br)); 817} 818#endif 819/* 820 * 72 was chosen below because it is the size of a TCP/IP 821 * header (40) + the minimum mss (32). 822 */ 823#define IF_MINMTU 72 824#define IF_MAXMTU 65535 825 826#define TOEDEV(ifp) ((ifp)->if_llsoftc) 827 828#endif /* _KERNEL */ 829 830/* 831 * The ifaddr structure contains information about one address 832 * of an interface. They are maintained by the different address families, 833 * are allocated and attached when an address is set, and are linked 834 * together so all addresses for an interface can be located. 835 * 836 * NOTE: a 'struct ifaddr' is always at the beginning of a larger 837 * chunk of malloc'ed memory, where we store the three addresses 838 * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here. 839 */ 840struct ifaddr { 841 struct sockaddr *ifa_addr; /* address of interface */ 842 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 843#define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 844 struct sockaddr *ifa_netmask; /* used to determine subnet */ 845 struct if_data if_data; /* not all members are meaningful */ 846 struct ifnet *ifa_ifp; /* back-pointer to interface */ 847 struct carp_softc *ifa_carp; /* pointer to CARP data */ 848 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */ 849 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 850 (int, struct rtentry *, struct rt_addrinfo *); 851 u_short ifa_flags; /* mostly rt_flags for cloning */ 852 u_int ifa_refcnt; /* references to this structure */ 853 int ifa_metric; /* cost of going out this interface */ 854 int (*ifa_claim_addr) /* check if an addr goes to this if */ 855 (struct ifaddr *, struct sockaddr *); 856 struct mtx ifa_mtx; 857}; 858#define IFA_ROUTE RTF_UP /* route installed */ 859#define IFA_RTSELF RTF_HOST /* loopback route to self installed */ 860 861/* for compatibility with other BSDs */ 862#define ifa_list ifa_link 863 864#ifdef _KERNEL 865#define IFA_LOCK(ifa) mtx_lock(&(ifa)->ifa_mtx) 866#define IFA_UNLOCK(ifa) mtx_unlock(&(ifa)->ifa_mtx) 867 868void ifa_free(struct ifaddr *ifa); 869void ifa_init(struct ifaddr *ifa); 870void ifa_ref(struct ifaddr *ifa); 871#endif 872 873/* 874 * Multicast address structure. This is analogous to the ifaddr 875 * structure except that it keeps track of multicast addresses. 876 */ 877struct ifmultiaddr { 878 TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */ 879 struct sockaddr *ifma_addr; /* address this membership is for */ 880 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */ 881 struct ifnet *ifma_ifp; /* back-pointer to interface */ 882 u_int ifma_refcount; /* reference count */ 883 void *ifma_protospec; /* protocol-specific state, if any */ 884 struct ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */ 885}; 886 887#ifdef _KERNEL 888 889extern struct rwlock ifnet_rwlock; 890extern struct sx ifnet_sxlock; 891 892#define IFNET_LOCK_INIT() do { \ 893 rw_init_flags(&ifnet_rwlock, "ifnet_rw", RW_RECURSE); \ 894 sx_init_flags(&ifnet_sxlock, "ifnet_sx", SX_RECURSE); \ 895} while(0) 896 897#define IFNET_WLOCK() do { \ 898 sx_xlock(&ifnet_sxlock); \ 899 rw_wlock(&ifnet_rwlock); \ 900} while (0) 901 902#define IFNET_WUNLOCK() do { \ 903 rw_wunlock(&ifnet_rwlock); \ 904 sx_xunlock(&ifnet_sxlock); \ 905} while (0) 906 907/* 908 * To assert the ifnet lock, you must know not only whether it's for read or 909 * write, but also whether it was acquired with sleep support or not. 910 */ 911#define IFNET_RLOCK_ASSERT() sx_assert(&ifnet_sxlock, SA_SLOCKED) 912#define IFNET_RLOCK_NOSLEEP_ASSERT() rw_assert(&ifnet_rwlock, RA_RLOCKED) 913#define IFNET_WLOCK_ASSERT() do { \ 914 sx_assert(&ifnet_sxlock, SA_XLOCKED); \ 915 rw_assert(&ifnet_rwlock, RA_WLOCKED); \ 916} while (0) 917 918#define IFNET_RLOCK() sx_slock(&ifnet_sxlock) 919#define IFNET_RLOCK_NOSLEEP() rw_rlock(&ifnet_rwlock) 920#define IFNET_RUNLOCK() sx_sunlock(&ifnet_sxlock) 921#define IFNET_RUNLOCK_NOSLEEP() rw_runlock(&ifnet_rwlock) 922 923/* 924 * Look up an ifnet given its index; the _ref variant also acquires a 925 * reference that must be freed using if_rele(). It is almost always a bug 926 * to call ifnet_byindex() instead if ifnet_byindex_ref(). 927 */ 928struct ifnet *ifnet_byindex(u_short idx); 929struct ifnet *ifnet_byindex_locked(u_short idx); 930struct ifnet *ifnet_byindex_ref(u_short idx); 931 932/* 933 * Given the index, ifaddr_byindex() returns the one and only 934 * link-level ifaddr for the interface. You are not supposed to use 935 * it to traverse the list of addresses associated to the interface. 936 */ 937struct ifaddr *ifaddr_byindex(u_short idx); 938 939VNET_DECLARE(struct ifnethead, ifnet); 940VNET_DECLARE(struct ifgrouphead, ifg_head); 941VNET_DECLARE(int, if_index); 942VNET_DECLARE(struct ifnet *, loif); /* first loopback interface */ 943VNET_DECLARE(int, useloopback); 944 945#define V_ifnet VNET(ifnet) 946#define V_ifg_head VNET(ifg_head) 947#define V_if_index VNET(if_index) 948#define V_loif VNET(loif) 949#define V_useloopback VNET(useloopback) 950 951extern int ifqmaxlen; 952 953int if_addgroup(struct ifnet *, const char *); 954int if_delgroup(struct ifnet *, const char *); 955int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **); 956int if_allmulti(struct ifnet *, int); 957struct ifnet* if_alloc(u_char); 958void if_attach(struct ifnet *); 959void if_dead(struct ifnet *); 960int if_delmulti(struct ifnet *, struct sockaddr *); 961void if_delmulti_ifma(struct ifmultiaddr *); 962void if_detach(struct ifnet *); 963void if_vmove(struct ifnet *, struct vnet *); 964void if_purgeaddrs(struct ifnet *); 965void if_delallmulti(struct ifnet *); 966void if_down(struct ifnet *); 967struct ifmultiaddr * 968 if_findmulti(struct ifnet *, struct sockaddr *); 969void if_free(struct ifnet *); 970void if_initname(struct ifnet *, const char *, int); 971void if_link_state_change(struct ifnet *, int); 972int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3); 973void if_qflush(struct ifnet *); 974void if_ref(struct ifnet *); 975void if_rele(struct ifnet *); 976int if_setlladdr(struct ifnet *, const u_char *, int); 977int if_gethwaddr(struct ifnet *, struct ifreq *); 978void if_up(struct ifnet *); 979int ifioctl(struct socket *, u_long, caddr_t, struct thread *); 980int ifpromisc(struct ifnet *, int); 981struct ifnet *ifunit(const char *); 982struct ifnet *ifunit_ref(const char *); 983 984void ifq_init(struct ifaltq *, struct ifnet *ifp); 985void ifq_delete(struct ifaltq *); 986 987int ifa_add_loopback_route(struct ifaddr *, struct sockaddr *); 988int ifa_del_loopback_route(struct ifaddr *, struct sockaddr *); 989 990struct ifaddr *ifa_ifwithaddr(struct sockaddr *); 991int ifa_ifwithaddr_check(struct sockaddr *); 992struct ifaddr *ifa_ifwithbroadaddr(struct sockaddr *); 993struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *); 994struct ifaddr *ifa_ifwithdstaddr_fib(struct sockaddr *, int); 995struct ifaddr *ifa_ifwithnet(struct sockaddr *, int); 996struct ifaddr *ifa_ifwithnet_fib(struct sockaddr *, int, int); 997struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *); 998struct ifaddr *ifa_ifwithroute_fib(int, struct sockaddr *, struct sockaddr *, u_int); 999struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *); 1000int ifa_preferred(struct ifaddr *, struct ifaddr *); 1001 1002int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen); 1003 1004typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp); 1005typedef void if_com_free_t(void *com, u_char type); 1006void if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f); 1007void if_deregister_com_alloc(u_char type); 1008uint64_t if_get_counter_default(struct ifnet *, ift_counter); 1009void if_inc_counter(struct ifnet *, ift_counter, int64_t); 1010 1011#define IF_LLADDR(ifp) \ 1012 LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr)) 1013 1014#ifdef DEVICE_POLLING 1015enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS }; 1016 1017typedef int poll_handler_t(struct ifnet *ifp, enum poll_cmd cmd, int count); 1018int ether_poll_register(poll_handler_t *h, struct ifnet *ifp); 1019int ether_poll_deregister(struct ifnet *ifp); 1020#endif /* DEVICE_POLLING */ 1021 1022/* TSO */ 1023void if_hw_tsomax_common(struct ifnet *, struct ifnet_hw_tsomax *); 1024int if_hw_tsomax_update(struct ifnet *, struct ifnet_hw_tsomax *); 1025 1026#endif /* _KERNEL */ 1027 1028#endif /* !_NET_IF_VAR_H_ */ 1029