2 * Copyright (c) 1982, 1986, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
29 * From: @(#)if.h 8.1 (Berkeley) 6/10/93
33 #ifndef _NET_IF_VAR_H_
34 #define _NET_IF_VAR_H_
37 * Structures defining a network interface, providing a packet
38 * transport mechanism (ala level 0 of the PUP protocols).
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.
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.
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.
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
63 * Forward structure declarations for function prototypes [sic].
77 #include <sys/queue.h> /* get TAILQ macros */
81 #include <sys/eventhandler.h>
82 #include <sys/buf_ring.h>
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>
92 #define IF_DUNIT_NONE -1
94 #include <altq/if_altq.h>
96 TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */
97 TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */
98 TAILQ_HEAD(ifprefixhead, ifprefix);
99 TAILQ_HEAD(ifmultihead, ifmultiaddr);
100 TAILQ_HEAD(ifgrouphead, ifg_group);
103 * Structure defining a queue for a network interface.
106 struct mbuf *ifq_head;
107 struct mbuf *ifq_tail;
115 * Structure defining a network interface.
117 * (Would like to call this struct ``if'', but C isn't PL/1.)
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 */
131 * if_addrhead is the list of all addresses associated to
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
137 * However, access to the AF_LINK address through this
138 * field is deprecated. Use if_addr or ifaddr_byindex() instead.
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_timer; /* time 'til if_watchdog called */
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 *,
158 void (*if_input) /* input routine (from h/w driver) */
159 (struct ifnet *, struct mbuf *);
160 void (*if_start) /* initiate output routine */
162 int (*if_ioctl) /* ioctl routine */
163 (struct ifnet *, u_long, caddr_t);
164 void (*if_watchdog) /* timer routine */
166 void (*if_init) /* Init routine */
168 int (*if_resolvemulti) /* validate/resolve multicast */
169 (struct ifnet *, struct sockaddr **, struct sockaddr *);
170 void (*if_qflush) /* flush any queues */
172 int (*if_transmit) /* initiate output routine */
173 (struct ifnet *, struct mbuf *);
174 void (*if_reassign) /* reassign to vnet routine */
175 (struct ifnet *, struct vnet *, char *);
176 struct vnet *if_home_vnet; /* where this ifnet originates from */
177 struct ifaddr *if_addr; /* pointer to link-level address */
178 void *if_llsoftc; /* link layer softc */
179 int if_drv_flags; /* driver-managed status flags */
180 struct ifaltq if_snd; /* output queue (includes altq) */
181 const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
183 void *if_bridge; /* bridge glue */
185 struct label *if_label; /* interface MAC label */
187 /* these are only used by IPv6 */
188 struct ifprefixhead if_prefixhead; /* list of prefixes per if */
189 void *if_afdata[AF_MAX];
190 int if_afdata_initialized;
191 struct rwlock if_afdata_lock;
192 struct task if_linktask; /* task for link change events */
193 struct mtx if_addr_mtx; /* mutex to protect address lists */
195 LIST_ENTRY(ifnet) if_clones; /* interfaces of a cloner */
196 TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
197 /* protected by if_addr_mtx */
199 void *if_lagg; /* lagg glue */
200 u_char if_alloctype; /* if_type at time of allocation */
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.
208 char *if_description; /* interface description */
213 typedef void if_init_f_t(void *);
216 * XXX These aliases are terribly dangerous because they could apply
219 #define if_mtu if_data.ifi_mtu
220 #define if_type if_data.ifi_type
221 #define if_physical if_data.ifi_physical
222 #define if_addrlen if_data.ifi_addrlen
223 #define if_hdrlen if_data.ifi_hdrlen
224 #define if_metric if_data.ifi_metric
225 #define if_link_state if_data.ifi_link_state
226 #define if_baudrate if_data.ifi_baudrate
227 #define if_hwassist if_data.ifi_hwassist
228 #define if_ipackets if_data.ifi_ipackets
229 #define if_ierrors if_data.ifi_ierrors
230 #define if_opackets if_data.ifi_opackets
231 #define if_oerrors if_data.ifi_oerrors
232 #define if_collisions if_data.ifi_collisions
233 #define if_ibytes if_data.ifi_ibytes
234 #define if_obytes if_data.ifi_obytes
235 #define if_imcasts if_data.ifi_imcasts
236 #define if_omcasts if_data.ifi_omcasts
237 #define if_iqdrops if_data.ifi_iqdrops
238 #define if_noproto if_data.ifi_noproto
239 #define if_lastchange if_data.ifi_lastchange
241 /* for compatibility with other BSDs */
242 #define if_addrlist if_addrhead
243 #define if_list if_link
244 #define if_name(ifp) ((ifp)->if_xname)
247 * Locks for address lists on the network interface.
249 #define IF_ADDR_LOCK_INIT(if) mtx_init(&(if)->if_addr_mtx, \
250 "if_addr_mtx", NULL, MTX_DEF)
251 #define IF_ADDR_LOCK_DESTROY(if) mtx_destroy(&(if)->if_addr_mtx)
252 #define IF_ADDR_WLOCK(if) mtx_lock(&(if)->if_addr_mtx)
253 #define IF_ADDR_WUNLOCK(if) mtx_unlock(&(if)->if_addr_mtx)
254 #define IF_ADDR_RLOCK(if) mtx_lock(&(if)->if_addr_mtx)
255 #define IF_ADDR_RUNLOCK(if) mtx_unlock(&(if)->if_addr_mtx)
256 #define IF_ADDR_LOCK_ASSERT(if) mtx_assert(&(if)->if_addr_mtx, MA_OWNED)
257 #define IF_ADDR_WLOCK_ASSERT(if) mtx_assert(&(if)->if_addr_mtx, MA_OWNED)
259 #define IF_ADDR_LOCK(if) IF_ADDR_WLOCK(if)
260 #define IF_ADDR_UNLOCK(if) IF_ADDR_WUNLOCK(if)
263 * Function variations on locking macros intended to be used by loadable
264 * kernel modules in order to divorce them from the internals of address list
267 void if_addr_rlock(struct ifnet *ifp); /* if_addrhead */
268 void if_addr_runlock(struct ifnet *ifp); /* if_addrhead */
269 void if_maddr_rlock(struct ifnet *ifp); /* if_multiaddrs */
270 void if_maddr_runlock(struct ifnet *ifp); /* if_multiaddrs */
273 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
274 * are queues of messages stored on ifqueue structures
275 * (defined above). Entries are added to and deleted from these structures
276 * by these macros, which should be called with ipl raised to splimp().
278 #define IF_LOCK(ifq) mtx_lock(&(ifq)->ifq_mtx)
279 #define IF_UNLOCK(ifq) mtx_unlock(&(ifq)->ifq_mtx)
280 #define IF_LOCK_ASSERT(ifq) mtx_assert(&(ifq)->ifq_mtx, MA_OWNED)
281 #define _IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
282 #define _IF_DROP(ifq) ((ifq)->ifq_drops++)
283 #define _IF_QLEN(ifq) ((ifq)->ifq_len)
285 #define _IF_ENQUEUE(ifq, m) do { \
286 (m)->m_nextpkt = NULL; \
287 if ((ifq)->ifq_tail == NULL) \
288 (ifq)->ifq_head = m; \
290 (ifq)->ifq_tail->m_nextpkt = m; \
291 (ifq)->ifq_tail = m; \
295 #define IF_ENQUEUE(ifq, m) do { \
297 _IF_ENQUEUE(ifq, m); \
301 #define _IF_PREPEND(ifq, m) do { \
302 (m)->m_nextpkt = (ifq)->ifq_head; \
303 if ((ifq)->ifq_tail == NULL) \
304 (ifq)->ifq_tail = (m); \
305 (ifq)->ifq_head = (m); \
309 #define IF_PREPEND(ifq, m) do { \
311 _IF_PREPEND(ifq, m); \
315 #define _IF_DEQUEUE(ifq, m) do { \
316 (m) = (ifq)->ifq_head; \
318 if (((ifq)->ifq_head = (m)->m_nextpkt) == NULL) \
319 (ifq)->ifq_tail = NULL; \
320 (m)->m_nextpkt = NULL; \
325 #define IF_DEQUEUE(ifq, m) do { \
327 _IF_DEQUEUE(ifq, m); \
331 #define _IF_POLL(ifq, m) ((m) = (ifq)->ifq_head)
332 #define IF_POLL(ifq, m) _IF_POLL(ifq, m)
334 #define _IF_DRAIN(ifq) do { \
337 _IF_DEQUEUE(ifq, m); \
344 #define IF_DRAIN(ifq) do { \
351 /* interface link layer address change event */
352 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
353 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
354 /* interface address change event */
355 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
356 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
357 /* new interface arrival event */
358 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *);
359 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
360 /* interface departure event */
361 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *);
362 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
368 char ifg_group[IFNAMSIZ];
371 TAILQ_HEAD(, ifg_member) ifg_members;
372 TAILQ_ENTRY(ifg_group) ifg_next;
376 TAILQ_ENTRY(ifg_member) ifgm_next;
377 struct ifnet *ifgm_ifp;
381 struct ifg_group *ifgl_group;
382 TAILQ_ENTRY(ifg_list) ifgl_next;
385 /* group attach event */
386 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
387 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
388 /* group detach event */
389 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
390 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
391 /* group change event */
392 typedef void (*group_change_event_handler_t)(void *, const char *);
393 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
395 #define IF_AFDATA_LOCK_INIT(ifp) \
396 rw_init(&(ifp)->if_afdata_lock, "if_afdata")
398 #define IF_AFDATA_WLOCK(ifp) rw_wlock(&(ifp)->if_afdata_lock)
399 #define IF_AFDATA_RLOCK(ifp) rw_rlock(&(ifp)->if_afdata_lock)
400 #define IF_AFDATA_WUNLOCK(ifp) rw_wunlock(&(ifp)->if_afdata_lock)
401 #define IF_AFDATA_RUNLOCK(ifp) rw_runlock(&(ifp)->if_afdata_lock)
402 #define IF_AFDATA_LOCK(ifp) IF_AFDATA_WLOCK(ifp)
403 #define IF_AFDATA_UNLOCK(ifp) IF_AFDATA_WUNLOCK(ifp)
404 #define IF_AFDATA_TRYLOCK(ifp) rw_try_wlock(&(ifp)->if_afdata_lock)
405 #define IF_AFDATA_DESTROY(ifp) rw_destroy(&(ifp)->if_afdata_lock)
407 #define IF_AFDATA_LOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_LOCKED)
408 #define IF_AFDATA_UNLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_UNLOCKED)
410 int if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp,
412 #define IF_HANDOFF(ifq, m, ifp) \
413 if_handoff((struct ifqueue *)ifq, m, ifp, 0)
414 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj) \
415 if_handoff((struct ifqueue *)ifq, m, ifp, adj)
417 void if_start(struct ifnet *);
419 #define IFQ_ENQUEUE(ifq, m, err) \
422 if (ALTQ_IS_ENABLED(ifq)) \
423 ALTQ_ENQUEUE(ifq, m, NULL, err); \
425 if (_IF_QFULL(ifq)) { \
429 _IF_ENQUEUE(ifq, m); \
434 (ifq)->ifq_drops++; \
438 #define IFQ_DEQUEUE_NOLOCK(ifq, m) \
440 if (TBR_IS_ENABLED(ifq)) \
441 (m) = tbr_dequeue_ptr(ifq, ALTDQ_REMOVE); \
442 else if (ALTQ_IS_ENABLED(ifq)) \
443 ALTQ_DEQUEUE(ifq, m); \
445 _IF_DEQUEUE(ifq, m); \
448 #define IFQ_DEQUEUE(ifq, m) \
451 IFQ_DEQUEUE_NOLOCK(ifq, m); \
455 #define IFQ_POLL_NOLOCK(ifq, m) \
457 if (TBR_IS_ENABLED(ifq)) \
458 (m) = tbr_dequeue_ptr(ifq, ALTDQ_POLL); \
459 else if (ALTQ_IS_ENABLED(ifq)) \
465 #define IFQ_POLL(ifq, m) \
468 IFQ_POLL_NOLOCK(ifq, m); \
472 #define IFQ_PURGE_NOLOCK(ifq) \
474 if (ALTQ_IS_ENABLED(ifq)) { \
480 #define IFQ_PURGE(ifq) \
483 IFQ_PURGE_NOLOCK(ifq); \
487 #define IFQ_SET_READY(ifq) \
488 do { ((ifq)->altq_flags |= ALTQF_READY); } while (0)
490 #define IFQ_LOCK(ifq) IF_LOCK(ifq)
491 #define IFQ_UNLOCK(ifq) IF_UNLOCK(ifq)
492 #define IFQ_LOCK_ASSERT(ifq) IF_LOCK_ASSERT(ifq)
493 #define IFQ_IS_EMPTY(ifq) ((ifq)->ifq_len == 0)
494 #define IFQ_INC_LEN(ifq) ((ifq)->ifq_len++)
495 #define IFQ_DEC_LEN(ifq) (--(ifq)->ifq_len)
496 #define IFQ_INC_DROPS(ifq) ((ifq)->ifq_drops++)
497 #define IFQ_SET_MAXLEN(ifq, len) ((ifq)->ifq_maxlen = (len))
500 * The IFF_DRV_OACTIVE test should really occur in the device driver, not in
501 * the handoff logic, as that flag is locked by the device driver.
503 #define IFQ_HANDOFF_ADJ(ifp, m, adj, err) \
508 len = (m)->m_pkthdr.len; \
509 mflags = (m)->m_flags; \
510 IFQ_ENQUEUE(&(ifp)->if_snd, m, err); \
512 (ifp)->if_obytes += len + (adj); \
513 if (mflags & M_MCAST) \
514 (ifp)->if_omcasts++; \
515 if (((ifp)->if_drv_flags & IFF_DRV_OACTIVE) == 0) \
520 #define IFQ_HANDOFF(ifp, m, err) \
521 IFQ_HANDOFF_ADJ(ifp, m, 0, err)
523 #define IFQ_DRV_DEQUEUE(ifq, m) \
525 (m) = (ifq)->ifq_drv_head; \
527 if (((ifq)->ifq_drv_head = (m)->m_nextpkt) == NULL) \
528 (ifq)->ifq_drv_tail = NULL; \
529 (m)->m_nextpkt = NULL; \
530 (ifq)->ifq_drv_len--; \
533 IFQ_DEQUEUE_NOLOCK(ifq, m); \
534 while ((ifq)->ifq_drv_len < (ifq)->ifq_drv_maxlen) { \
536 IFQ_DEQUEUE_NOLOCK(ifq, m0); \
539 m0->m_nextpkt = NULL; \
540 if ((ifq)->ifq_drv_tail == NULL) \
541 (ifq)->ifq_drv_head = m0; \
543 (ifq)->ifq_drv_tail->m_nextpkt = m0; \
544 (ifq)->ifq_drv_tail = m0; \
545 (ifq)->ifq_drv_len++; \
551 #define IFQ_DRV_PREPEND(ifq, m) \
553 (m)->m_nextpkt = (ifq)->ifq_drv_head; \
554 if ((ifq)->ifq_drv_tail == NULL) \
555 (ifq)->ifq_drv_tail = (m); \
556 (ifq)->ifq_drv_head = (m); \
557 (ifq)->ifq_drv_len++; \
560 #define IFQ_DRV_IS_EMPTY(ifq) \
561 (((ifq)->ifq_drv_len == 0) && ((ifq)->ifq_len == 0))
563 #define IFQ_DRV_PURGE(ifq) \
565 struct mbuf *m, *n = (ifq)->ifq_drv_head; \
566 while((m = n) != NULL) { \
570 (ifq)->ifq_drv_head = (ifq)->ifq_drv_tail = NULL; \
571 (ifq)->ifq_drv_len = 0; \
577 drbr_stats_update(struct ifnet *ifp, int len, int mflags)
579 #ifndef NO_SLOW_STATS
580 ifp->if_obytes += len;
581 if (mflags & M_MCAST)
587 drbr_enqueue(struct ifnet *ifp, struct buf_ring *br, struct mbuf *m)
590 int len = m->m_pkthdr.len;
591 int mflags = m->m_flags;
594 if (ALTQ_IS_ENABLED(&ifp->if_snd)) {
595 IFQ_ENQUEUE(&ifp->if_snd, m, error);
599 if ((error = buf_ring_enqueue_bytes(br, m, len)) == ENOBUFS) {
603 drbr_stats_update(ifp, len, mflags);
609 drbr_flush(struct ifnet *ifp, struct buf_ring *br)
614 if (ifp != NULL && ALTQ_IS_ENABLED(&ifp->if_snd))
615 IFQ_PURGE(&ifp->if_snd);
617 while ((m = buf_ring_dequeue_sc(br)) != NULL)
622 drbr_free(struct buf_ring *br, struct malloc_type *type)
625 drbr_flush(NULL, br);
626 buf_ring_free(br, type);
629 static __inline struct mbuf *
630 drbr_dequeue(struct ifnet *ifp, struct buf_ring *br)
635 if (ALTQ_IS_ENABLED(&ifp->if_snd)) {
636 IFQ_DEQUEUE(&ifp->if_snd, m);
640 return (buf_ring_dequeue_sc(br));
643 static __inline struct mbuf *
644 drbr_dequeue_cond(struct ifnet *ifp, struct buf_ring *br,
645 int (*func) (struct mbuf *, void *), void *arg)
649 if (ALTQ_IS_ENABLED(&ifp->if_snd)) {
650 IFQ_LOCK(&ifp->if_snd);
651 IFQ_POLL_NOLOCK(&ifp->if_snd, m);
652 if (m != NULL && func(m, arg) == 0) {
653 IFQ_UNLOCK(&ifp->if_snd);
656 IFQ_DEQUEUE_NOLOCK(&ifp->if_snd, m);
657 IFQ_UNLOCK(&ifp->if_snd);
661 m = buf_ring_peek(br);
662 if (m == NULL || func(m, arg) == 0)
665 return (buf_ring_dequeue_sc(br));
669 drbr_empty(struct ifnet *ifp, struct buf_ring *br)
672 if (ALTQ_IS_ENABLED(&ifp->if_snd))
673 return (IFQ_IS_EMPTY(&ifp->if_snd));
675 return (buf_ring_empty(br));
679 drbr_needs_enqueue(struct ifnet *ifp, struct buf_ring *br)
682 if (ALTQ_IS_ENABLED(&ifp->if_snd))
685 return (!buf_ring_empty(br));
689 drbr_inuse(struct ifnet *ifp, struct buf_ring *br)
692 if (ALTQ_IS_ENABLED(&ifp->if_snd))
693 return (ifp->if_snd.ifq_len);
695 return (buf_ring_count(br));
699 * 72 was chosen below because it is the size of a TCP/IP
700 * header (40) + the minimum mss (32).
703 #define IF_MAXMTU 65535
708 * The ifaddr structure contains information about one address
709 * of an interface. They are maintained by the different address families,
710 * are allocated and attached when an address is set, and are linked
711 * together so all addresses for an interface can be located.
713 * NOTE: a 'struct ifaddr' is always at the beginning of a larger
714 * chunk of malloc'ed memory, where we store the three addresses
715 * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
718 struct sockaddr *ifa_addr; /* address of interface */
719 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
720 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
721 struct sockaddr *ifa_netmask; /* used to determine subnet */
722 struct if_data if_data; /* not all members are meaningful */
723 struct ifnet *ifa_ifp; /* back-pointer to interface */
724 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */
725 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
726 (int, struct rtentry *, struct rt_addrinfo *);
727 u_short ifa_flags; /* mostly rt_flags for cloning */
728 u_int ifa_refcnt; /* references to this structure */
729 int ifa_metric; /* cost of going out this interface */
730 int (*ifa_claim_addr) /* check if an addr goes to this if */
731 (struct ifaddr *, struct sockaddr *);
734 #define IFA_ROUTE RTF_UP /* route installed */
735 #define IFA_RTSELF RTF_HOST /* loopback route to self installed */
737 /* for compatibility with other BSDs */
738 #define ifa_list ifa_link
741 #define IFA_LOCK(ifa) mtx_lock(&(ifa)->ifa_mtx)
742 #define IFA_UNLOCK(ifa) mtx_unlock(&(ifa)->ifa_mtx)
744 void ifa_free(struct ifaddr *ifa);
745 void ifa_init(struct ifaddr *ifa);
746 void ifa_ref(struct ifaddr *ifa);
750 * The prefix structure contains information about one prefix
751 * of an interface. They are maintained by the different address families,
752 * are allocated and attached when a prefix or an address is set,
753 * and are linked together so all prefixes for an interface can be located.
756 struct sockaddr *ifpr_prefix; /* prefix of interface */
757 struct ifnet *ifpr_ifp; /* back-pointer to interface */
758 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
759 u_char ifpr_plen; /* prefix length in bits */
760 u_char ifpr_type; /* protocol dependent prefix type */
764 * Multicast address structure. This is analogous to the ifaddr
765 * structure except that it keeps track of multicast addresses.
768 TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
769 struct sockaddr *ifma_addr; /* address this membership is for */
770 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
771 struct ifnet *ifma_ifp; /* back-pointer to interface */
772 u_int ifma_refcount; /* reference count */
773 void *ifma_protospec; /* protocol-specific state, if any */
774 struct ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
779 extern struct rwlock ifnet_rwlock;
780 extern struct sx ifnet_sxlock;
782 #define IFNET_LOCK_INIT() do { \
783 rw_init_flags(&ifnet_rwlock, "ifnet_rw", RW_RECURSE); \
784 sx_init_flags(&ifnet_sxlock, "ifnet_sx", SX_RECURSE); \
787 #define IFNET_WLOCK() do { \
788 sx_xlock(&ifnet_sxlock); \
789 rw_wlock(&ifnet_rwlock); \
792 #define IFNET_WUNLOCK() do { \
793 rw_wunlock(&ifnet_rwlock); \
794 sx_xunlock(&ifnet_sxlock); \
798 * To assert the ifnet lock, you must know not only whether it's for read or
799 * write, but also whether it was acquired with sleep support or not.
801 #define IFNET_RLOCK_ASSERT() sx_assert(&ifnet_sxlock, SA_SLOCKED)
802 #define IFNET_RLOCK_NOSLEEP_ASSERT() rw_assert(&ifnet_rwlock, RA_RLOCKED)
803 #define IFNET_WLOCK_ASSERT() do { \
804 sx_assert(&ifnet_sxlock, SA_XLOCKED); \
805 rw_assert(&ifnet_rwlock, RA_WLOCKED); \
808 #define IFNET_RLOCK() sx_slock(&ifnet_sxlock)
809 #define IFNET_RLOCK_NOSLEEP() rw_rlock(&ifnet_rwlock)
810 #define IFNET_RUNLOCK() sx_sunlock(&ifnet_sxlock)
811 #define IFNET_RUNLOCK_NOSLEEP() rw_runlock(&ifnet_rwlock)
814 * Look up an ifnet given its index; the _ref variant also acquires a
815 * reference that must be freed using if_rele(). It is almost always a bug
816 * to call ifnet_byindex() instead if ifnet_byindex_ref().
818 struct ifnet *ifnet_byindex(u_short idx);
819 struct ifnet *ifnet_byindex_locked(u_short idx);
820 struct ifnet *ifnet_byindex_ref(u_short idx);
823 * Given the index, ifaddr_byindex() returns the one and only
824 * link-level ifaddr for the interface. You are not supposed to use
825 * it to traverse the list of addresses associated to the interface.
827 struct ifaddr *ifaddr_byindex(u_short idx);
829 VNET_DECLARE(struct ifnethead, ifnet);
830 VNET_DECLARE(struct ifgrouphead, ifg_head);
831 VNET_DECLARE(int, if_index);
832 VNET_DECLARE(struct ifnet *, loif); /* first loopback interface */
833 VNET_DECLARE(int, useloopback);
835 #define V_ifnet VNET(ifnet)
836 #define V_ifg_head VNET(ifg_head)
837 #define V_if_index VNET(if_index)
838 #define V_loif VNET(loif)
839 #define V_useloopback VNET(useloopback)
841 extern int ifqmaxlen;
843 int if_addgroup(struct ifnet *, const char *);
844 int if_delgroup(struct ifnet *, const char *);
845 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
846 int if_allmulti(struct ifnet *, int);
847 struct ifnet* if_alloc(u_char);
848 void if_attach(struct ifnet *);
849 void if_dead(struct ifnet *);
850 int if_delmulti(struct ifnet *, struct sockaddr *);
851 void if_delmulti_ifma(struct ifmultiaddr *);
852 void if_detach(struct ifnet *);
853 void if_vmove(struct ifnet *, struct vnet *);
854 void if_purgeaddrs(struct ifnet *);
855 void if_delallmulti(struct ifnet *);
856 void if_down(struct ifnet *);
858 if_findmulti(struct ifnet *, struct sockaddr *);
859 void if_free(struct ifnet *);
860 void if_free_type(struct ifnet *, u_char);
861 void if_initname(struct ifnet *, const char *, int);
862 void if_link_state_change(struct ifnet *, int);
863 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
864 void if_qflush(struct ifnet *);
865 void if_ref(struct ifnet *);
866 void if_rele(struct ifnet *);
867 int if_setlladdr(struct ifnet *, const u_char *, int);
868 void if_up(struct ifnet *);
869 int ifioctl(struct socket *, u_long, caddr_t, struct thread *);
870 int ifpromisc(struct ifnet *, int);
871 struct ifnet *ifunit(const char *);
872 struct ifnet *ifunit_ref(const char *);
874 void ifq_init(struct ifaltq *, struct ifnet *ifp);
875 void ifq_delete(struct ifaltq *);
877 int ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
878 int ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);
880 struct ifaddr *ifa_ifwithaddr(struct sockaddr *);
881 int ifa_ifwithaddr_check(struct sockaddr *);
882 struct ifaddr *ifa_ifwithbroadaddr(struct sockaddr *);
883 struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
884 struct ifaddr *ifa_ifwithnet(struct sockaddr *, int);
885 struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
886 struct ifaddr *ifa_ifwithroute_fib(int, struct sockaddr *, struct sockaddr *, u_int);
888 struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
890 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
892 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
893 typedef void if_com_free_t(void *com, u_char type);
894 void if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
895 void if_deregister_com_alloc(u_char type);
897 #define IF_LLADDR(ifp) \
898 LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr))
900 #ifdef DEVICE_POLLING
901 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS };
903 typedef int poll_handler_t(struct ifnet *ifp, enum poll_cmd cmd, int count);
904 int ether_poll_register(poll_handler_t *h, struct ifnet *ifp);
905 int ether_poll_deregister(struct ifnet *ifp);
906 #endif /* DEVICE_POLLING */
910 #endif /* !_NET_IF_VAR_H_ */