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