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