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;
114 struct ifnet_hw_tsomax {
115 u_int tsomaxbytes; /* TSO total burst length limit in bytes */
116 u_int tsomaxsegcount; /* TSO maximum segment count */
117 u_int tsomaxsegsize; /* TSO maximum segment size in bytes */
121 * Structure defining a network interface.
123 * (Would like to call this struct ``if'', but C isn't PL/1.)
127 void *if_softc; /* pointer to driver state */
128 void *if_l2com; /* pointer to protocol bits */
129 struct vnet *if_vnet; /* pointer to network stack instance */
130 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */
131 char if_xname[IFNAMSIZ]; /* external name (name + unit) */
132 const char *if_dname; /* driver name */
133 int if_dunit; /* unit or IF_DUNIT_NONE */
134 u_int if_refcount; /* reference count */
135 struct ifaddrhead if_addrhead; /* linked list of addresses per if */
137 * if_addrhead is the list of all addresses associated to
139 * Some code in the kernel assumes that first element
140 * of the list has type AF_LINK, and contains sockaddr_dl
141 * addresses which store the link-level address and the name
143 * However, access to the AF_LINK address through this
144 * field is deprecated. Use if_addr or ifaddr_byindex() instead.
146 int if_pcount; /* number of promiscuous listeners */
147 struct carp_if *if_carp; /* carp interface structure */
148 struct bpf_if *if_bpf; /* packet filter structure */
149 u_short if_index; /* numeric abbreviation for this if */
150 short if_index_reserved; /* spare space to grow if_index */
151 struct ifvlantrunk *if_vlantrunk; /* pointer to 802.1q data */
152 int if_flags; /* up/down, broadcast, etc. */
153 int if_capabilities; /* interface features & capabilities */
154 int if_capenable; /* enabled features & capabilities */
155 void *if_linkmib; /* link-type-specific MIB data */
156 size_t if_linkmiblen; /* length of above data */
157 struct if_data if_data;
158 struct ifmultihead if_multiaddrs; /* multicast addresses configured */
159 int if_amcount; /* number of all-multicast requests */
160 /* procedure handles */
161 int (*if_output) /* output routine (enqueue) */
162 (struct ifnet *, struct mbuf *, struct sockaddr *,
164 void (*if_input) /* input routine (from h/w driver) */
165 (struct ifnet *, struct mbuf *);
166 void (*if_start) /* initiate output routine */
168 int (*if_ioctl) /* ioctl routine */
169 (struct ifnet *, u_long, caddr_t);
170 void (*if_init) /* Init routine */
172 int (*if_resolvemulti) /* validate/resolve multicast */
173 (struct ifnet *, struct sockaddr **, struct sockaddr *);
174 void (*if_qflush) /* flush any queues */
176 int (*if_transmit) /* initiate output routine */
177 (struct ifnet *, struct mbuf *);
178 void (*if_reassign) /* reassign to vnet routine */
179 (struct ifnet *, struct vnet *, char *);
180 struct vnet *if_home_vnet; /* where this ifnet originates from */
181 struct ifaddr *if_addr; /* pointer to link-level address */
182 void *if_llsoftc; /* link layer softc */
183 int if_drv_flags; /* driver-managed status flags */
184 struct ifaltq if_snd; /* output queue (includes altq) */
185 const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
187 void *if_bridge; /* bridge glue */
189 struct label *if_label; /* interface MAC label */
191 /* these are only used by IPv6 */
192 struct ifprefixhead if_prefixhead; /* list of prefixes per if */
193 void *if_afdata[AF_MAX];
194 int if_afdata_initialized;
195 struct rwlock if_afdata_lock;
196 struct task if_linktask; /* task for link change events */
197 struct mtx if_addr_mtx; /* mutex to protect address lists */
199 LIST_ENTRY(ifnet) if_clones; /* interfaces of a cloner */
200 TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
201 /* protected by if_addr_mtx */
203 void *if_lagg; /* lagg glue */
204 char *if_description; /* interface description */
205 u_int if_fib; /* interface FIB */
206 u_char if_alloctype; /* if_type at time of allocation */
209 * Spare fields are added so that we can modify sensitive data
210 * structures without changing the kernel binary interface, and must
211 * be used with care where binary compatibility is required.
216 * Network adapter TSO limits:
217 * ===========================
219 * If the "if_hw_tsomax" field is zero the maximum segment
220 * length limit does not apply. If the "if_hw_tsomaxsegcount"
221 * or the "if_hw_tsomaxsegsize" field is zero the TSO segment
222 * count limit does not apply. If all three fields are zero,
223 * there is no TSO limit.
225 * NOTE: The TSO limits only apply to the data payload part of
226 * a TCP/IP packet. That means there is no need to subtract
227 * space for ethernet-, vlan-, IP- or TCP- headers from the
228 * TSO limits unless the hardware driver in question requires
234 * TSO fields for segment limits. If a field is zero below,
237 u_int if_hw_tsomaxsegcount; /* TSO maximum segment count */
238 u_int if_hw_tsomaxsegsize; /* TSO maximum segment size in bytes */
239 void *if_pspare[8]; /* 1 netmap, 7 TDB */
242 typedef void if_init_f_t(void *);
245 * XXX These aliases are terribly dangerous because they could apply
248 #define if_mtu if_data.ifi_mtu
249 #define if_type if_data.ifi_type
250 #define if_physical if_data.ifi_physical
251 #define if_addrlen if_data.ifi_addrlen
252 #define if_hdrlen if_data.ifi_hdrlen
253 #define if_metric if_data.ifi_metric
254 #define if_link_state if_data.ifi_link_state
255 #define if_baudrate if_data.ifi_baudrate
256 #define if_hwassist if_data.ifi_hwassist
257 #define if_ipackets if_data.ifi_ipackets
258 #define if_ierrors if_data.ifi_ierrors
259 #define if_opackets if_data.ifi_opackets
260 #define if_oerrors if_data.ifi_oerrors
261 #define if_collisions if_data.ifi_collisions
262 #define if_ibytes if_data.ifi_ibytes
263 #define if_obytes if_data.ifi_obytes
264 #define if_imcasts if_data.ifi_imcasts
265 #define if_omcasts if_data.ifi_omcasts
266 #define if_iqdrops if_data.ifi_iqdrops
267 #define if_noproto if_data.ifi_noproto
268 #define if_lastchange if_data.ifi_lastchange
270 /* for compatibility with other BSDs */
271 #define if_addrlist if_addrhead
272 #define if_list if_link
273 #define if_name(ifp) ((ifp)->if_xname)
276 * Locks for address lists on the network interface.
278 #define IF_ADDR_LOCK_INIT(if) mtx_init(&(if)->if_addr_mtx, \
279 "if_addr_mtx", NULL, MTX_DEF)
280 #define IF_ADDR_LOCK_DESTROY(if) mtx_destroy(&(if)->if_addr_mtx)
281 #define IF_ADDR_WLOCK(if) mtx_lock(&(if)->if_addr_mtx)
282 #define IF_ADDR_WUNLOCK(if) mtx_unlock(&(if)->if_addr_mtx)
283 #define IF_ADDR_RLOCK(if) mtx_lock(&(if)->if_addr_mtx)
284 #define IF_ADDR_RUNLOCK(if) mtx_unlock(&(if)->if_addr_mtx)
285 #define IF_ADDR_LOCK_ASSERT(if) mtx_assert(&(if)->if_addr_mtx, MA_OWNED)
286 #define IF_ADDR_WLOCK_ASSERT(if) mtx_assert(&(if)->if_addr_mtx, MA_OWNED)
288 #define IF_ADDR_LOCK(if) IF_ADDR_WLOCK(if)
289 #define IF_ADDR_UNLOCK(if) IF_ADDR_WUNLOCK(if)
292 * Function variations on locking macros intended to be used by loadable
293 * kernel modules in order to divorce them from the internals of address list
296 void if_addr_rlock(struct ifnet *ifp); /* if_addrhead */
297 void if_addr_runlock(struct ifnet *ifp); /* if_addrhead */
298 void if_maddr_rlock(struct ifnet *ifp); /* if_multiaddrs */
299 void if_maddr_runlock(struct ifnet *ifp); /* if_multiaddrs */
302 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
303 * are queues of messages stored on ifqueue structures
304 * (defined above). Entries are added to and deleted from these structures
305 * by these macros, which should be called with ipl raised to splimp().
307 #define IF_LOCK(ifq) mtx_lock(&(ifq)->ifq_mtx)
308 #define IF_UNLOCK(ifq) mtx_unlock(&(ifq)->ifq_mtx)
309 #define IF_LOCK_ASSERT(ifq) mtx_assert(&(ifq)->ifq_mtx, MA_OWNED)
310 #define _IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
311 #define _IF_DROP(ifq) ((ifq)->ifq_drops++)
312 #define _IF_QLEN(ifq) ((ifq)->ifq_len)
314 #define _IF_ENQUEUE(ifq, m) do { \
315 (m)->m_nextpkt = NULL; \
316 if ((ifq)->ifq_tail == NULL) \
317 (ifq)->ifq_head = m; \
319 (ifq)->ifq_tail->m_nextpkt = m; \
320 (ifq)->ifq_tail = m; \
324 #define IF_ENQUEUE(ifq, m) do { \
326 _IF_ENQUEUE(ifq, m); \
330 #define _IF_PREPEND(ifq, m) do { \
331 (m)->m_nextpkt = (ifq)->ifq_head; \
332 if ((ifq)->ifq_tail == NULL) \
333 (ifq)->ifq_tail = (m); \
334 (ifq)->ifq_head = (m); \
338 #define IF_PREPEND(ifq, m) do { \
340 _IF_PREPEND(ifq, m); \
344 #define _IF_DEQUEUE(ifq, m) do { \
345 (m) = (ifq)->ifq_head; \
347 if (((ifq)->ifq_head = (m)->m_nextpkt) == NULL) \
348 (ifq)->ifq_tail = NULL; \
349 (m)->m_nextpkt = NULL; \
354 #define IF_DEQUEUE(ifq, m) do { \
356 _IF_DEQUEUE(ifq, m); \
360 #define _IF_DEQUEUE_ALL(ifq, m) do { \
361 (m) = (ifq)->ifq_head; \
362 (ifq)->ifq_head = (ifq)->ifq_tail = NULL; \
363 (ifq)->ifq_len = 0; \
366 #define IF_DEQUEUE_ALL(ifq, m) do { \
368 _IF_DEQUEUE_ALL(ifq, m); \
372 #define _IF_POLL(ifq, m) ((m) = (ifq)->ifq_head)
373 #define IF_POLL(ifq, m) _IF_POLL(ifq, m)
375 #define _IF_DRAIN(ifq) do { \
378 _IF_DEQUEUE(ifq, m); \
385 #define IF_DRAIN(ifq) do { \
392 /* interface link layer address change event */
393 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
394 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
395 /* interface address change event */
396 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
397 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
398 /* new interface arrival event */
399 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *);
400 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
401 /* interface departure event */
402 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *);
403 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
404 /* Interface link state change event */
405 typedef void (*ifnet_link_event_handler_t)(void *, struct ifnet *, int);
406 EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t);
412 char ifg_group[IFNAMSIZ];
415 TAILQ_HEAD(, ifg_member) ifg_members;
416 TAILQ_ENTRY(ifg_group) ifg_next;
420 TAILQ_ENTRY(ifg_member) ifgm_next;
421 struct ifnet *ifgm_ifp;
425 struct ifg_group *ifgl_group;
426 TAILQ_ENTRY(ifg_list) ifgl_next;
429 /* group attach event */
430 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
431 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
432 /* group detach event */
433 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
434 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
435 /* group change event */
436 typedef void (*group_change_event_handler_t)(void *, const char *);
437 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
439 #define IF_AFDATA_LOCK_INIT(ifp) \
440 rw_init(&(ifp)->if_afdata_lock, "if_afdata")
442 #define IF_AFDATA_WLOCK(ifp) rw_wlock(&(ifp)->if_afdata_lock)
443 #define IF_AFDATA_RLOCK(ifp) rw_rlock(&(ifp)->if_afdata_lock)
444 #define IF_AFDATA_WUNLOCK(ifp) rw_wunlock(&(ifp)->if_afdata_lock)
445 #define IF_AFDATA_RUNLOCK(ifp) rw_runlock(&(ifp)->if_afdata_lock)
446 #define IF_AFDATA_LOCK(ifp) IF_AFDATA_WLOCK(ifp)
447 #define IF_AFDATA_UNLOCK(ifp) IF_AFDATA_WUNLOCK(ifp)
448 #define IF_AFDATA_TRYLOCK(ifp) rw_try_wlock(&(ifp)->if_afdata_lock)
449 #define IF_AFDATA_DESTROY(ifp) rw_destroy(&(ifp)->if_afdata_lock)
451 #define IF_AFDATA_LOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_LOCKED)
452 #define IF_AFDATA_RLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_RLOCKED)
453 #define IF_AFDATA_WLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_WLOCKED)
454 #define IF_AFDATA_UNLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_UNLOCKED)
456 int if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp,
458 #define IF_HANDOFF(ifq, m, ifp) \
459 if_handoff((struct ifqueue *)ifq, m, ifp, 0)
460 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj) \
461 if_handoff((struct ifqueue *)ifq, m, ifp, adj)
463 void if_start(struct ifnet *);
465 #define IFQ_ENQUEUE(ifq, m, err) \
468 if (ALTQ_IS_ENABLED(ifq)) \
469 ALTQ_ENQUEUE(ifq, m, NULL, err); \
471 if (_IF_QFULL(ifq)) { \
475 _IF_ENQUEUE(ifq, m); \
480 (ifq)->ifq_drops++; \
484 #define IFQ_DEQUEUE_NOLOCK(ifq, m) \
486 if (TBR_IS_ENABLED(ifq)) \
487 (m) = tbr_dequeue_ptr(ifq, ALTDQ_REMOVE); \
488 else if (ALTQ_IS_ENABLED(ifq)) \
489 ALTQ_DEQUEUE(ifq, m); \
491 _IF_DEQUEUE(ifq, m); \
494 #define IFQ_DEQUEUE(ifq, m) \
497 IFQ_DEQUEUE_NOLOCK(ifq, m); \
501 #define IFQ_POLL_NOLOCK(ifq, m) \
503 if (TBR_IS_ENABLED(ifq)) \
504 (m) = tbr_dequeue_ptr(ifq, ALTDQ_POLL); \
505 else if (ALTQ_IS_ENABLED(ifq)) \
511 #define IFQ_POLL(ifq, m) \
514 IFQ_POLL_NOLOCK(ifq, m); \
518 #define IFQ_PURGE_NOLOCK(ifq) \
520 if (ALTQ_IS_ENABLED(ifq)) { \
526 #define IFQ_PURGE(ifq) \
529 IFQ_PURGE_NOLOCK(ifq); \
533 #define IFQ_SET_READY(ifq) \
534 do { ((ifq)->altq_flags |= ALTQF_READY); } while (0)
536 #define IFQ_LOCK(ifq) IF_LOCK(ifq)
537 #define IFQ_UNLOCK(ifq) IF_UNLOCK(ifq)
538 #define IFQ_LOCK_ASSERT(ifq) IF_LOCK_ASSERT(ifq)
539 #define IFQ_IS_EMPTY(ifq) ((ifq)->ifq_len == 0)
540 #define IFQ_INC_LEN(ifq) ((ifq)->ifq_len++)
541 #define IFQ_DEC_LEN(ifq) (--(ifq)->ifq_len)
542 #define IFQ_INC_DROPS(ifq) ((ifq)->ifq_drops++)
543 #define IFQ_SET_MAXLEN(ifq, len) ((ifq)->ifq_maxlen = (len))
546 * The IFF_DRV_OACTIVE test should really occur in the device driver, not in
547 * the handoff logic, as that flag is locked by the device driver.
549 #define IFQ_HANDOFF_ADJ(ifp, m, adj, err) \
554 len = (m)->m_pkthdr.len; \
555 mflags = (m)->m_flags; \
556 IFQ_ENQUEUE(&(ifp)->if_snd, m, err); \
558 (ifp)->if_obytes += len + (adj); \
559 if (mflags & M_MCAST) \
560 (ifp)->if_omcasts++; \
561 if (((ifp)->if_drv_flags & IFF_DRV_OACTIVE) == 0) \
566 #define IFQ_HANDOFF(ifp, m, err) \
567 IFQ_HANDOFF_ADJ(ifp, m, 0, err)
569 #define IFQ_DRV_DEQUEUE(ifq, m) \
571 (m) = (ifq)->ifq_drv_head; \
573 if (((ifq)->ifq_drv_head = (m)->m_nextpkt) == NULL) \
574 (ifq)->ifq_drv_tail = NULL; \
575 (m)->m_nextpkt = NULL; \
576 (ifq)->ifq_drv_len--; \
579 IFQ_DEQUEUE_NOLOCK(ifq, m); \
580 while ((ifq)->ifq_drv_len < (ifq)->ifq_drv_maxlen) { \
582 IFQ_DEQUEUE_NOLOCK(ifq, m0); \
585 m0->m_nextpkt = NULL; \
586 if ((ifq)->ifq_drv_tail == NULL) \
587 (ifq)->ifq_drv_head = m0; \
589 (ifq)->ifq_drv_tail->m_nextpkt = m0; \
590 (ifq)->ifq_drv_tail = m0; \
591 (ifq)->ifq_drv_len++; \
597 #define IFQ_DRV_PREPEND(ifq, m) \
599 (m)->m_nextpkt = (ifq)->ifq_drv_head; \
600 if ((ifq)->ifq_drv_tail == NULL) \
601 (ifq)->ifq_drv_tail = (m); \
602 (ifq)->ifq_drv_head = (m); \
603 (ifq)->ifq_drv_len++; \
606 #define IFQ_DRV_IS_EMPTY(ifq) \
607 (((ifq)->ifq_drv_len == 0) && ((ifq)->ifq_len == 0))
609 #define IFQ_DRV_PURGE(ifq) \
611 struct mbuf *m, *n = (ifq)->ifq_drv_head; \
612 while((m = n) != NULL) { \
616 (ifq)->ifq_drv_head = (ifq)->ifq_drv_tail = NULL; \
617 (ifq)->ifq_drv_len = 0; \
623 drbr_enqueue(struct ifnet *ifp, struct buf_ring *br, struct mbuf *m)
628 if (ALTQ_IS_ENABLED(&ifp->if_snd)) {
629 IFQ_ENQUEUE(&ifp->if_snd, m, error);
633 error = buf_ring_enqueue(br, m);
641 drbr_putback(struct ifnet *ifp, struct buf_ring *br, struct mbuf *new)
644 * The top of the list needs to be swapped
648 if (ifp != NULL && ALTQ_IS_ENABLED(&ifp->if_snd)) {
650 * Peek in altq case dequeued it
653 IFQ_DRV_PREPEND(&ifp->if_snd, new);
657 buf_ring_putback_sc(br, new);
660 static __inline struct mbuf *
661 drbr_peek(struct ifnet *ifp, struct buf_ring *br)
665 if (ifp != NULL && ALTQ_IS_ENABLED(&ifp->if_snd)) {
667 * Pull it off like a dequeue
668 * since drbr_advance() does nothing
669 * for altq and drbr_putback() will
670 * use the old prepend function.
672 IFQ_DEQUEUE(&ifp->if_snd, m);
676 return(buf_ring_peek(br));
680 drbr_flush(struct ifnet *ifp, struct buf_ring *br)
685 if (ifp != NULL && ALTQ_IS_ENABLED(&ifp->if_snd))
686 IFQ_PURGE(&ifp->if_snd);
688 while ((m = buf_ring_dequeue_sc(br)) != NULL)
693 drbr_free(struct buf_ring *br, struct malloc_type *type)
696 drbr_flush(NULL, br);
697 buf_ring_free(br, type);
700 static __inline struct mbuf *
701 drbr_dequeue(struct ifnet *ifp, struct buf_ring *br)
706 if (ifp != NULL && ALTQ_IS_ENABLED(&ifp->if_snd)) {
707 IFQ_DEQUEUE(&ifp->if_snd, m);
711 return (buf_ring_dequeue_sc(br));
715 drbr_advance(struct ifnet *ifp, struct buf_ring *br)
718 /* Nothing to do here since peek dequeues in altq case */
719 if (ifp != NULL && ALTQ_IS_ENABLED(&ifp->if_snd))
722 return (buf_ring_advance_sc(br));
726 static __inline struct mbuf *
727 drbr_dequeue_cond(struct ifnet *ifp, struct buf_ring *br,
728 int (*func) (struct mbuf *, void *), void *arg)
732 if (ALTQ_IS_ENABLED(&ifp->if_snd)) {
733 IFQ_LOCK(&ifp->if_snd);
734 IFQ_POLL_NOLOCK(&ifp->if_snd, m);
735 if (m != NULL && func(m, arg) == 0) {
736 IFQ_UNLOCK(&ifp->if_snd);
739 IFQ_DEQUEUE_NOLOCK(&ifp->if_snd, m);
740 IFQ_UNLOCK(&ifp->if_snd);
744 m = buf_ring_peek(br);
745 if (m == NULL || func(m, arg) == 0)
748 return (buf_ring_dequeue_sc(br));
752 drbr_empty(struct ifnet *ifp, struct buf_ring *br)
755 if (ALTQ_IS_ENABLED(&ifp->if_snd))
756 return (IFQ_IS_EMPTY(&ifp->if_snd));
758 return (buf_ring_empty(br));
762 drbr_needs_enqueue(struct ifnet *ifp, struct buf_ring *br)
765 if (ALTQ_IS_ENABLED(&ifp->if_snd))
768 return (!buf_ring_empty(br));
772 drbr_inuse(struct ifnet *ifp, struct buf_ring *br)
775 if (ALTQ_IS_ENABLED(&ifp->if_snd))
776 return (ifp->if_snd.ifq_len);
778 return (buf_ring_count(br));
782 * 72 was chosen below because it is the size of a TCP/IP
783 * header (40) + the minimum mss (32).
786 #define IF_MAXMTU 65535
788 #define TOEDEV(ifp) ((ifp)->if_llsoftc)
793 * The ifaddr structure contains information about one address
794 * of an interface. They are maintained by the different address families,
795 * are allocated and attached when an address is set, and are linked
796 * together so all addresses for an interface can be located.
798 * NOTE: a 'struct ifaddr' is always at the beginning of a larger
799 * chunk of malloc'ed memory, where we store the three addresses
800 * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
803 struct sockaddr *ifa_addr; /* address of interface */
804 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
805 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
806 struct sockaddr *ifa_netmask; /* used to determine subnet */
807 struct if_data if_data; /* not all members are meaningful */
808 struct ifnet *ifa_ifp; /* back-pointer to interface */
809 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */
810 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
811 (int, struct rtentry *, struct rt_addrinfo *);
812 u_short ifa_flags; /* mostly rt_flags for cloning */
813 u_int ifa_refcnt; /* references to this structure */
814 int ifa_metric; /* cost of going out this interface */
815 int (*ifa_claim_addr) /* check if an addr goes to this if */
816 (struct ifaddr *, struct sockaddr *);
819 #define IFA_ROUTE RTF_UP /* route installed */
820 #define IFA_RTSELF RTF_HOST /* loopback route to self installed */
822 /* for compatibility with other BSDs */
823 #define ifa_list ifa_link
826 #define IFA_LOCK(ifa) mtx_lock(&(ifa)->ifa_mtx)
827 #define IFA_UNLOCK(ifa) mtx_unlock(&(ifa)->ifa_mtx)
829 void ifa_free(struct ifaddr *ifa);
830 void ifa_init(struct ifaddr *ifa);
831 void ifa_ref(struct ifaddr *ifa);
835 * The prefix structure contains information about one prefix
836 * of an interface. They are maintained by the different address families,
837 * are allocated and attached when a prefix or an address is set,
838 * and are linked together so all prefixes for an interface can be located.
841 struct sockaddr *ifpr_prefix; /* prefix of interface */
842 struct ifnet *ifpr_ifp; /* back-pointer to interface */
843 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
844 u_char ifpr_plen; /* prefix length in bits */
845 u_char ifpr_type; /* protocol dependent prefix type */
849 * Multicast address structure. This is analogous to the ifaddr
850 * structure except that it keeps track of multicast addresses.
853 TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
854 struct sockaddr *ifma_addr; /* address this membership is for */
855 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
856 struct ifnet *ifma_ifp; /* back-pointer to interface */
857 u_int ifma_refcount; /* reference count */
858 void *ifma_protospec; /* protocol-specific state, if any */
859 struct ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
864 extern struct rwlock ifnet_rwlock;
865 extern struct sx ifnet_sxlock;
867 #define IFNET_LOCK_INIT() do { \
868 rw_init_flags(&ifnet_rwlock, "ifnet_rw", RW_RECURSE); \
869 sx_init_flags(&ifnet_sxlock, "ifnet_sx", SX_RECURSE); \
872 #define IFNET_WLOCK() do { \
873 sx_xlock(&ifnet_sxlock); \
874 rw_wlock(&ifnet_rwlock); \
877 #define IFNET_WUNLOCK() do { \
878 rw_wunlock(&ifnet_rwlock); \
879 sx_xunlock(&ifnet_sxlock); \
883 * To assert the ifnet lock, you must know not only whether it's for read or
884 * write, but also whether it was acquired with sleep support or not.
886 #define IFNET_RLOCK_ASSERT() sx_assert(&ifnet_sxlock, SA_SLOCKED)
887 #define IFNET_RLOCK_NOSLEEP_ASSERT() rw_assert(&ifnet_rwlock, RA_RLOCKED)
888 #define IFNET_WLOCK_ASSERT() do { \
889 sx_assert(&ifnet_sxlock, SA_XLOCKED); \
890 rw_assert(&ifnet_rwlock, RA_WLOCKED); \
893 #define IFNET_RLOCK() sx_slock(&ifnet_sxlock)
894 #define IFNET_RLOCK_NOSLEEP() rw_rlock(&ifnet_rwlock)
895 #define IFNET_RUNLOCK() sx_sunlock(&ifnet_sxlock)
896 #define IFNET_RUNLOCK_NOSLEEP() rw_runlock(&ifnet_rwlock)
899 * Look up an ifnet given its index; the _ref variant also acquires a
900 * reference that must be freed using if_rele(). It is almost always a bug
901 * to call ifnet_byindex() instead if ifnet_byindex_ref().
903 struct ifnet *ifnet_byindex(u_short idx);
904 struct ifnet *ifnet_byindex_locked(u_short idx);
905 struct ifnet *ifnet_byindex_ref(u_short idx);
908 * Given the index, ifaddr_byindex() returns the one and only
909 * link-level ifaddr for the interface. You are not supposed to use
910 * it to traverse the list of addresses associated to the interface.
912 struct ifaddr *ifaddr_byindex(u_short idx);
914 VNET_DECLARE(struct ifnethead, ifnet);
915 VNET_DECLARE(struct ifgrouphead, ifg_head);
916 VNET_DECLARE(int, if_index);
917 VNET_DECLARE(struct ifnet *, loif); /* first loopback interface */
918 VNET_DECLARE(int, useloopback);
920 #define V_ifnet VNET(ifnet)
921 #define V_ifg_head VNET(ifg_head)
922 #define V_if_index VNET(if_index)
923 #define V_loif VNET(loif)
924 #define V_useloopback VNET(useloopback)
926 extern int ifqmaxlen;
928 int if_addgroup(struct ifnet *, const char *);
929 int if_delgroup(struct ifnet *, const char *);
930 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
931 int if_allmulti(struct ifnet *, int);
932 struct ifnet* if_alloc(u_char);
933 void if_attach(struct ifnet *);
934 void if_dead(struct ifnet *);
935 int if_delmulti(struct ifnet *, struct sockaddr *);
936 void if_delmulti_ifma(struct ifmultiaddr *);
937 void if_detach(struct ifnet *);
938 void if_vmove(struct ifnet *, struct vnet *);
939 void if_purgeaddrs(struct ifnet *);
940 void if_delallmulti(struct ifnet *);
941 void if_down(struct ifnet *);
943 if_findmulti(struct ifnet *, struct sockaddr *);
944 void if_free(struct ifnet *);
945 void if_free_type(struct ifnet *, u_char);
946 void if_initname(struct ifnet *, const char *, int);
947 void if_link_state_change(struct ifnet *, int);
948 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
949 void if_qflush(struct ifnet *);
950 void if_ref(struct ifnet *);
951 void if_rele(struct ifnet *);
952 int if_setlladdr(struct ifnet *, const u_char *, int);
953 void if_up(struct ifnet *);
954 int ifioctl(struct socket *, u_long, caddr_t, struct thread *);
955 int ifpromisc(struct ifnet *, int);
956 struct ifnet *ifunit(const char *);
957 struct ifnet *ifunit_ref(const char *);
959 void ifq_init(struct ifaltq *, struct ifnet *ifp);
960 void ifq_delete(struct ifaltq *);
962 int ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
963 int ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);
965 struct ifaddr *ifa_ifwithaddr(struct sockaddr *);
966 int ifa_ifwithaddr_check(struct sockaddr *);
967 struct ifaddr *ifa_ifwithbroadaddr(struct sockaddr *);
968 struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
969 struct ifaddr *ifa_ifwithdstaddr_fib(struct sockaddr *, int);
970 struct ifaddr *ifa_ifwithnet(struct sockaddr *, int);
971 struct ifaddr *ifa_ifwithnet_fib(struct sockaddr *, int, int);
972 struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
973 struct ifaddr *ifa_ifwithroute_fib(int, struct sockaddr *, struct sockaddr *, u_int);
975 struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
977 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
979 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
980 typedef void if_com_free_t(void *com, u_char type);
981 void if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
982 void if_deregister_com_alloc(u_char type);
984 #define IF_LLADDR(ifp) \
985 LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr))
987 #ifdef DEVICE_POLLING
988 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS };
990 typedef int poll_handler_t(struct ifnet *ifp, enum poll_cmd cmd, int count);
991 int ether_poll_register(poll_handler_t *h, struct ifnet *ifp);
992 int ether_poll_deregister(struct ifnet *ifp);
993 #endif /* DEVICE_POLLING */
996 void if_hw_tsomax_common(struct ifnet *, struct ifnet_hw_tsomax *);
997 int if_hw_tsomax_update(struct ifnet *, struct ifnet_hw_tsomax *);
1001 #endif /* !_NET_IF_VAR_H_ */