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