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