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