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