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