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