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